Reading Source File, Rsrc or Font (for each atom) 11
Writing Target File, Rsrc or Font (for each atom) 11
Finalizing 11
Installer Human Interface
Easy Install Interface 12
Using the Target Disk Interface 13
Using the Application Folder Interface 13
Buttons 13
Custom Install Interface 14
Custom Install List 14
Selected Size and Disk Space Available Values 15
Custom Item Information 15
Custom Remove Interface 16
Selecting the Target Application Folder 17
Selecting the System Volume 18
Adding a Splash Screen 19
Providing User Help 20
Selecting an Installer Document 20
Menus 21
Apple Menu 22
Help Menu 22
Application Menu 22
Using the Installer Preference Resource (‘inpr’) 22
Controlling the Recommended Target Selection 23
Specifying Help Pages 23
Allowing Installation onto AppleShare Volumes 24
Installer Preference Resource Reference 24
Resource Description 24
Data Structures 26
Packages and Atoms
About Packages (‘inpk’) 27
Using Packages 27
Using Packages with Easy Install 27
Using Packages with Custom Install and Remove 27
Atom Execution Order 28
Package Reference 28
Package Resource Description 28
Package Comment Resource Description 30
New Package Comment Resource Description 30
Old Package Comment Resource Description 31
About the File Atom 32
Using the File Atom (‘infa’) 32
Comparing Files by Version 32
Using Split Sources with File Atoms 33
Using Atom Extenders with File Atoms 33
Installing a Custom Folder Icon 34
File Atom Reference 34
Resource Description 34
About the Resource Atom (‘inra’) 38
Using the Resource Atom 39
Comparing Files By Version 39
Using Split Sources with Resource Atoms 39
Using Atom Extenders with Resource Atoms 39
Resource Atom Reference 40
Resource Description 40
About the Resource List Atom (‘inr#’) 44
Using the Resource List Atom 44
Referencing Resource Atom Lists from Packages 44
Resource List Atom Reference 44
Resource Description 45
About the Font Atom (‘inff’) 46
Using the Font Atom 46
Auto-Routing Under Pre-7.1 Systems 46
Using Atom Extenders with Font Atoms 47
Font Atom Reference 47
Resource Description 47
About the ResMerge Atom (‘inrm’) 53
Using the ResMerge Atom 53
ResMerge Atom Reference 54
About the Folder Atom (‘infm’) 55
Using the Folder Atom 55
Specifying the Source and Target Folder 56
Installing Folders with Custom Icons 56
Creating Empty Folders with a Folder Atom 56
Folder Atom Reference 56
Using Action Atoms (‘inaa’) 57
Action Atom Reference 57
Resource Description 58
Data Structures 59
Function Interface 59
Parameter Block 59
Using Audit Atoms (‘inat’) 61
Audit Atom Reference 61
Resource Description 61
Using Boot Block Atoms (‘inbb’) 62
Boot Block Atom Reference 62
Resource Description 62
About Atom Extenders (‘inex’) 65
Writing Atom Extenders 66
Creating an ‘inex’ Script Resource 66
Writing a Simple Atom Extender 66
Memory Allocation within Atom Extenders 69
Running within a Sub-Heap 69
Converting Existing Decompression Code 70
Atom Extender Reference 70
Resource Description 70
Data Structures 72
Function Interface 72
Parameter Block 72
About Version Compare Functions (‘invc’) 76
Using Version Compare Functions with File Atoms 76
Using Version Compare Functions with Resource Atoms 77
Version Compare Runtime Environment 77
Version Compare Function Reference 77
Function Interface 77
Parameter Block 78
Resource Description 78
Installer Rules
Frameworks (‘infr’) 79
Global Rule Framework 79
Easy Install Rule Framework 79
Custom Install Rule Framework 80
Rules (‘inrl’) 80
Using Assertions 82
Rule Clause Reference 83
Global Rule Clauses 83
Easy Install Rule Clauses 91
Custom Install Rule Clauses 92
File Specification
About File Specifications 93
Specifying Target Files (‘intf’) 93
Installing into Special Folders 93
Installing into the User-Selected Application Folder 94
Managing Rollbacks on Multiple Target Volumes 94
Installing onto the Installer Volume 95
Setting the Finder flags and Dates 95
Specifying Source Files (‘infs’) 95
Source Disk Search Path 95
File Spec. Reference 96
Resource Descriptions 96
Target File Spec. Resource (‘intf’) 96
Source File Spec Resource (‘infs’) 98
About File Searching (‘insp’) 99
Using File Searching with File and Resource Atoms 99
Using File Searching with Rule Clauses 99
Allowable Installer Functions During File Searching 99
File Searching Reference 100
Data Structures 100
Function Interface 100
Parameter Block 100
Resource Description 101
About the Disk Order Resource (‘indo’) 102
Disk Order Reference 103
Resource Description 103
Installer Functions
About Installer Functions 104
Data I/O Routines 104
Memory Routines 108
Misc. Routines 110
Miscellaneous Features
About Action Handlers 113
Writing an Action Handler 113
Action Handler Runtime Environment 114
Action Handler Reference 114
Data Structures 114
Function Interface 114
Parameter Block 114
Actions 115
Resource Description 117
About the Installer Version Resource (‘invs’) 118
Installer Version Reference 119
Resource Description 119
About the Script Size Resource (‘insz’) 119
Script Size Reference 119
Resource Description 119
About the Script Creation Date Resource (‘incd’) 120
Script Creation Date Reference 120
Resource Description 120
Installation Topics
Installing Desk Accessories 121
Installing into Pre-7.X Systems 121
Installing into System 7.X 122
Glossary
Glossary 123
Scripting Overview
This chapter provides an overview of writing Installer scripts.
Scripting Overview
An Installer script is a list of instructions for the Installer, in the form of resources. These script resources tell the Installer how to perform an Installation. An Installer script is written using the MPW (Macintosh Programmer's Workshop) Rez language, and compiled using the MPW Rez tool. It is expected that Installer scriptwriters are familiar with the Rez language, MPW development system, and the MPW Rez tool.
The script resources can be divided into three main groups: script resources for displaying the interface, script resources for describing what actions to perform during the installation or removal, and independent script resources.
Script Resources for Displaying the Interface
The scriptwriter is responsible for providing a recommended software selection for Easy Install, and an optional list of software choices for Custom Install. Each interface requires the scriptwriter to create instructions (Installer rules) that are evaluated to tell the Installer what to display to the user and what will happen during the installation or removal.
It is useful to think of script resources as working in a hierarchy. At the top of the hierarchy are framework (‘infr’) and rule (‘inrl’) script resources. The Installer uses these resources to examine the environment and make decisions about what to install based on what it has found on the user’s target disk. For example, in System Software, we install different software depending on the type of machine the Installer is running on, the type of target disk the user has chosen, and what has previously been installed. To use these features, the scriptwriter must provide a set of if-then rules to reach the goal of each interface.
Easy Install interface goals:
n Create the recommended software message that will be shown in the Easy Install dialog. This translates into including the proper rule clauses that will display the desired message or error text.
n Tell the Installer what actions to take after the user clicks the Install button. This requires the scriptwriter to add to the list of packages that should be installed.
Custom Install interface goals:
n Specify the software components to be listed in the Custom Install dialog. Each top-level item equates to a package, with possible sub-packages, that the scriptwriter explicitly adds to the list.
Script Resources for Describing Actions
Installer rules specify the actions to be performed by selecting a set of packages (resource type 'inpk'). Packages have names, associated comment resources, and a list that references atoms. Atoms are script resources that describe a specific action to be performed during an installation or removal, such as copy a file or delete a resource.
In addition to atoms, packages may also reference other packages called subpackages. Subpackages are identical to packages and have two main purposes: to provide the hierarchical list shown in the Custom Install dialog and to make scripting simpler.
In the hierarchy of Installer script resources, atoms are at the lowest level. Atoms come in six flavors: File Atoms, Resource Atoms, Font Atoms, ResMerge Atoms, Folder Atoms, Action Atoms, Audit Atoms and Boot Block Atoms (resource types 'infa', 'inra', 'inff’, ‘inrm', ‘infm', 'inaa', 'inat', and 'inbb', respectively). Note that atoms are not visible to the user of the Installer program. All atoms are contained within packages or subpackages.
Independent Script Resources
Seven independent script resources can optionally be added to the script to control miscellaneous Installer actions and interface parts.
Installation Timeline
Many activities occur during an installation or removal. Keeping the order and dependencies straight is a challenge. To help you understand the specific events that happen during an installation, the seven phases are summarized below.
Launching
User opens Installer.
Installer finds and opens script document.
Read ‘insz’ if it exists and create the script’s sub-heap.
Find the Splash Screen PICT.
User reads and dismisses the Splash Screen.
Setup Function is called, if it exists.
Installer Rule Evaluation
Begin execution of Global Rules, then the rules for the current interface mode (Easy or Custom).
Call code resources referenced by CheckUserFunction and CheckRuleFunction rule clauses when, and if, the rule clause is evaluated.
Call File Searching code resources referenced by Target File Specs that are referenced by rule clauses. The code resource is called once for each Target File Spec regardless how many rule clauses reference the Target File Spec.
User sees the Easy, Custom or Remove dialog.
Preflighting
User clicks the Install or Remove button.
Preparing to install dialog appears.
Call File Search code resource for all relevant Target File Specs.
Check each target file, rsrc or font to compute needed space.
Call Version Compare code resource for File Atoms and Rsrc Atoms as necessary.
Verify that no target files match any source files.
Preparation to Install/Remove
Confirm shutting down running applications if live installation or removal.
Status Dialog appears.
Save off original files, as necessary, if disk space available.
Send ‘Initialize’ message to Atom Extenders.
Call ‘before’ Action Atoms.
Dispose of script sub-heap if extra memory is needed.
Delete old files, resources and fonts.
Reading Source File, Rsrc or Font (for each atom)
Open source file.
User sees “Reading…” in Status Dialog.
Send ‘BeforePart’ message to Atom Extender.
If the Atom Extender did not read the data, the Installer reads as much data as possible, placing each chunk into the buffer list. If not enough memory is free to buffer the data, the buffer list is flushed and the data is written to disk.
Close source file, if necessary.
Writing Target File, Rsrc or Font (for each atom)
Open target file.
User sees “Writing…” in Status Dialog.
Write buffered data into target file, rsrc or font resource.
Send ‘AfterPart’ message to Atom Extender.
Close target file, if necessary.
Finalizing
Send ‘Success’ or ‘Cancel ‘ message to Atom Extenders.
Send ‘after’ or ‘cleanUpCancel’ message to ‘after’ Action Atoms.
Successful or error dialog appears. If the user clicks the Continue button then the Installer continues with the next step then begins again with Rule execution.
Create script sub-heap again if we disposed of it earlier.
Installer Human Interface
This chapter describes the human interface aspects of Installer 4.0.
Easy Install Interface
The Easy Install interface now allows user selection of the target application folder and a larger message area. The target selection area is different for scripts requiring selection of an application folder versus selection of a target disk.
Figure 2-1 The Easy Install dialog.
Using the Target Disk Interface
If your product must always be installed into a specific location on the target disk, then you’ll probably want to limit the user to only selecting from the mounted volumes. This is the case for products, such as system software, that need to be installed predominately in the System Folder. Setting the useDiskTargetMode flag in the preference resource tells the Installer to present an interface compatible with the old Installer 3.X.
Clicking Switch Disk cycles through the mounted volumes. Clicking Eject Disk will eject a chosen ejectable disk.
Using the Application Folder Interface
If your script installs a product such as an application which can be placed most anywhere on the user's Macintosh, then you’ll probably want to allow the user to select a target folder. Setting the useFolderTargetMode flag in the preference resource tells the Installer to present an interface to the user for selecting the target folder in both the Easy Install and Custom Install dialogs. This interface is shown in Figure 2-2.
Much like the current special-xxxx folder path identifier, the new folder-user folder path identifier will be the folder path selected by the user. When the user clicks the Select Folder button a modified standard file dialog appears to allow selection of a new or existing folder. This dialog is discussed in the section “Using the Select Folder Dialog”.
Figure 2-2 The interface for selecting an application folder.
The icon and name for the selected folder depends on the folder chosen by the user:
n If a folder is selected, the folder’s icon will appear with the folder's name on the first line and “on the disk “Macintosh HD”” on the second line.
n If the root level of a volume is selected, the volume’s icon and name will appear.
A default target folder is always recommended to the user when first launching the Installer. The scriptwriter can optionally override the Installer’s suggested default folder using the preference resource.
Buttons
Buttons and their actions:
n Install (or Remove) — Starts the installation or removal. The button is enabled in Easy Install if there was not an error preventing the installation from beginning. In Custom Install and Custom Remove, the button is enabled only if one or more items are selected from the list.
n Quit — Quits the Installer application.
n Help — Opens a the Help dialog. The Help dialog is explained in section “Providing User Help”.
n Switch Disk — Changes the currently selected target disk to the next disk in the volume list. If no other volumes are available to choose from, this button is dimmed. This button is only shown when using the target disk interface mode.
n Eject Disk — Ejects the currently selected target disk. The button is dimmed if the current volume cannot be ejected. This button is only visible when using the target disk interface mode.
n Select Folder — Opens the folder selection dialog. The folder selection dialog is explained in section “Selecting the Target Application Folder”. If the scriptwriter has enabled this feature, and the Option Key is down, the button text changes to “System Disk” and opens the system volume selection dialog. The system volume selection dialog is explained in section “Selecting the System Volume”. This button is only visible when using the application folder interface mode.
Custom Install Interface
The Custom Install dialog can provide experienced users with the flexibility needed to create customized installations of your product.
Figure 2-3 The Custom Install dialog
Custom Install List
Hierarchical custom items allow many opportunities to provide specific choices without cluttering the list or confusing novice users. Users click on the familiar checkbox to select and deselect items in the custom list. Selection rules apply to the relationship between parent and child items:
n When the user selects/deselects an open parent item, all children are shown selected/deselected as well. This helps the user understand the relationship between the parent and child items. Selecting a parent is equal to selecting all the parent’s children and vice versa.
n If the user opens an unselected parent item and begins to select child items, the parent item is displayed with a mixed-state checkbox. A parent item becomes selected if all child items are selected. If all child items are unselected the parent item is displayed unselected. A parent item is displayed as a mixed-state checkbox if a child (which is also a parent item) is displaying a mixed-state checkbox.
Selected Size and Disk Space Available Values
Two additional information fields show the total size of the currently selected custom items and the disk space available on the selected target disk. The size information is very handy for users choosing which software options to install. The scriptwriter will have the option to show or hide these fields using a flag in the preference resource.
NOTE
The Installer only uses the leaf package sizes of the selected custom items to calculate the selected size value. For packages that referenece both atoms and sub-packages, it’s best to create another package that contains only the atoms and reference that package in place of the atoms.
For example, if you have this: Use this instead:
u
Custom Item Information
Custom item information can be viewed in a separate info dialog by clicking on the button () to the right of custom item text. The custom item info dialog is shown in Figure 2-4.
Figure 2-4 The Custom Item Info Dialog
Custom Remove Interface
Prior to Installer 4.0, the user had to hold down the option key to enable the remove feature. By selecting the Custom Remove pop-up menu item, the user can go to the Custom Remove window.
Figure 2-5 The Custom Remove dialog
The Custom Remove window layout looks very similar to that of Custom Install. The main difference is that the items in the Custom Install list which are not removable are dimmed, and the Install button is titled “Remove”.
Selecting the Target Application Folder
If the scriptwriter allows the user to select a target folder, a modified Standard File dialog is shown when the user clicks the Select Folder button. The Select Folder dialog is shown in Figure 2-6.
Figure 2-6 The Select Folder dialog
To select a target folder using the Select Folder dialog, the user selects the folder or disk in the list, and then clicks the Select button. If no items are selected, clicking the Select button chooses the folder or disk whose contents are showing in the list. The Open button is enabled whenever a folder, disk or alias is selected in the list. If the folder or disk is not a valid target disk the Select button is disabled, such as for a locked floppy disk or a sever volume.
The Installer always recommends a target application folder to the user when first launching the Installer. The user is shown the contents of the folder when first opening the Select Folder dialog. If the folder does not already exist, the folder is created so the user can either click Cancel or Select and maintain the recommended selection.
NOTE
We suggest that scriptwriters place the application and associated files and folders directly in the recommend target folder. This provides a visual association between the folder in the Installer’s dialog and the application folder of the same name that is created on the hard disk. This also allows an existing application to be updated more easily. u
Selecting the System Volume
Scriptwriters can allow the user to change the recommended system volume when using the application folder interface. A flag in the preference resource determines if this feature is enabled. The Installer initially recommends that system files be installed on the boot volume. The scriptwriter can override this recommendation using the Setup Function described in the section “Using the Installer Preference Resource”.
The user accesses the Select System Volume dialog by holding down the Option key while clicking the Select Folder button. The Select System Volume dialog is shown in Figure 4-6.
Figure 2-7 The Select System Volume dialog
The user can change the currently selected system volume by choosing a different volume from the pop-up menu. Only valid system volumes (those that contain blessed folders) are shown in the menu.
Adding a Splash Screen
The first screen to be displayed when the Installer is launched is found in the script. If you would like to provide your own splash screen, simply include a 'PICT' resource named “Splash Screen” with a resource ID greater than 1024. The Installer loads the picture from the script and displays it, along with an OK button in the lower right corner to dismiss the splash screen.
You can also have a color splash screen. In addition to the PICT named “Splash Screen”, include a color PICT named “Color Splash Screen”. If the screen has a depth of 4 bits per pixel or greater (16 colors/grays or more) then the Installer will use this PICT instead. Note that you should use the default system color palette for best results.
Create a picture using a drawing or painting program. You will want your picture to be no bigger than 220 (height) by 433 (width) pixels.
The AppleGaramond font is recommended for titles and the help screen fonts included with the SDK for text. Since you cannot be sure your chosen fonts will always be available, it’s best to create a bitmap picture when using fonts other than Geneva 9, 12, Chicago 12 and Monaco 9.
If necessary, convert the picture to a bitmap and copy it into the clipboard. Paste the picture from the clipboard into a newly created ResEdit file. This should create several resources, including a 'PICT' resource. Delete all of the resources you’ve created except the 'PICT'. Save the ResEdit 'PICT' file.
DeRez the ResEdit 'PICT' file using MPW. We use the following DeRez command:
This command appends the Rez definition of the 'PICT' to the end of your script.
Open the script file you just appended the 'PICT' to, go to the end, change the name of the 'PICT' resource (or give it a name if it doesn’t have one) to “Splash Screen”, and ensure that its ID is greater than 1024. Your script now contains the picture in a format Rez can handle when building the script into resource format.
Providing User Help
Clicking the Help button in the Installer window opens the Installer Help window which displays PICTs stored in the Installer or script file. The Installer Help window is shown in Figure 2-8.
Figure 2-8 The Installer Help window
The Installer ships with several simple help screens, but you can override specific default screens and add to the default help pages. The Preference Resource contains a list of the help pages and is discussed in the section “Using the Installer Preference Resource”.
NOTE
Easy-to-read screen fonts, as seen in Figure 2-8, are included in the SDK for your convenience. We suggest that you use these fonts for your help window and splash screen text. u
Selecting an Installer Document
When the user opens the Installer application directly the Installer searches the folder containing the application for one valid document. If no documents or multiple documents are found the Installer displays the dialog shown in Figure 2-9.
Figure 2-9 The Document Not Found Dialog
Clicking Choose displays the standard Open Dialog so the user can choose one Installer document to open. Clicking Cancel in the Open Dialog quits the Installer.
After opening the Installer document the Installer looks for the script version resource (‘invs’) to determine if the version of the Installer application is properly matched to the version of the script. With Installer version 4.0.3 and newer, the Installer will allow the user to open a document with a smaller version than the Installer. If this is the case, the Installer shows the dialog in Figure 2-10.
Figure 2-9 The Early Version Document Dialog
Menus
To allow the user to easily switch processes and to turn balloon help on and off the Help menu and Application menus will be shown under System 7.X. An “About Installer…” item will be shown in the Apple menu.
Apple Menu
The Apple Menu will be shown in full when running under 7.X, but will only contain the “About Installer…” item when running on pre-7.0 systems. Desk Accessories will not be shown in the menu under pre-7.0 systems to restrict DAs from being opened within the Installer.
Figure 2-10 The Apple Menu.
Help Menu
The Help menu will be available to users when running under System 7.X. In addition to the standard two menu items the Installer will add an “Installer Help…” item that opens the Installer’s help window.
Figure 2-11 The Help Menu.
The Help menu is not available when running under pre-7.0 systems.
Application Menu
The Application menu will be available to users when running under System 7.X. Under pre-7.0 systems using MultiFinder the user can switch between applications by clicking on the MultiFinder icon.
Figure 2-12 The Application Menu.
Using the Installer Preference Resource (‘inpr’)
The preference resource allows the scriptwriter to override certain default interface features and actions of the Installer. To utilize this control you must add a preference resource (‘inpr’ ID=300) to the script file. The Installer contains a default ‘inpr’ resource with the ID of 305. The Installer first looks for your ‘inpr’ with the ID 300, and if not found uses its default resource.
The fields and flags in the preference resource control two main areas of the Installer, the recommended target disk/folder selection, and specific human interface elements.
Controlling the Recommended Target Selection
The Installer automatically recommends the target disk, target folder and system disk if the scriptwriter does not provide a preference resource in the script file. If you wish to allow the user to select a target folder then it’s important to at least provide a suggested folder name in your preference resource. To have more control over the recommended target disk, target folder and system disk you can supply a code resource to be called to determine these values. This code resource is referred to as the setup function.
The setup function can recommend the initial values for target disk, target folder and system disk, but the Installer will consider these new values only as suggestions and will not use any value that would be unreasonable. The setup function is called prior to rule execution, or if a splash screen is provided, after the user dismisses the splash screen.
If no setup function is supplied, or a value recommend by the setup function is not valid, the Installer selects the target values using the following strategy:
n Target disk — The Installer first looks for the selected boot disk (value stored in PRAM), then looks at the SCSI ID 0 hard disk, then at the other SCSI disks, then for an old HD 20 hard disk, then any mounted floppies, then the RAM disk, and finally any mounted volume.
n Target application folder — Selects the folder with the name specified in the script file’s preference resource on the root level of the target disk. If the scriptwriter does not provide a preference resource, the preference resource in the Installer file will be used. The current default folder name is “Applications”.
n System disk — Looks first at the boot disk and then the selected boot disk (value stored in PRAM), and if one contains a blessed System Folder and is a valid target volume and not a floppy disk selects that volume. Otherwise, selects the recommended target disk regardless if it contains a blessed System Folder or not.
Specifying Help Pages
The preference resource holds the list of ‘PICT’ resource IDs that specify the pages shown in the help window.
The help window is divided into two vertical sections:
n Graphic Section — This section begins at the left edge of the window and extends to the right edge of the window. Most often you’ll use this section to display a 100 pixel wide color graphic that can be shared among several pages. This strategy saves disk space. If you have simple help pages that are all B/W, then use this section to display a ‘PICT’ resource that is the same width as the help window. Enter zero for the ID to leave this section blank.
n Text Section — This section begins 100 pixels from the left edge of the window and extends to the right edge of the window. This section is used most often to hold text that does not contain color. Enter zero for the ID to leave this section blank.
Two ‘PICT’ resource IDs must be entered for each section, one for display on B/W monitors and the other for monitors displaying 256 or more colors/grays. You may use the same ID for both color and B/W ‘PICT’ IDs. Use the special ID of 0 (zero) to display white space in a section.
The Installer ships with several basic help pages, which you can add to or replace with your own ‘PICT’ resources stored in your script file.
Allowing Installation onto AppleShare Volumes
Using the allowServerAsTarget flag allows the user to select and install onto AppleShare volumes. This flag is an unsupported and untested feature, and is available only as a courtesy to those developers that have hacked previous versions of the Installer to gain this functionality.
s W A R N I N G
Only those scriptwriters that absolutely, positively, must allow their users to install onto AppleShare server volumes should use the allowServerAsTarget flag! You should never try to install anything into the server volume’s System Folder! s
Installer Preference Resource Reference
This section describes the resource description of the ‘inpr’ resource.
Specifies whether the user can choose a target folder, or is limited to choosing a target disk. If the useDiskTargetMode flag is specified, “Switch Disk ” and “Eject Disk” buttons are shown to the user. This is very similar to the old Installer 3.X. If the ‘useFolderTargetMode’ flag is specified, the interface appears with a “Select Folder…” button, instead of the “Switch Disk ” and “Eject Disk” buttons.
Specifies whether the user can change the recommended System disk. If the allowUserToSetSystemDisk flag is specified, the “Select Folder…” button changes to “System Disk…” when the Option Key is depressed. Clicking the “System Disk…” button displays a dialog with a pop-up of the valid System disks.
The allowUserToSetSystemDisk flag is ignored unless the useFolderTargetMode flag is set (see section above). If the useDiskTargetMode flag is used, there is no change to the “SwitchDisk” button when the Option Key is pressed.
Specifies whether the Installer should calculate and show the total size of the currently selected custom items in the Custom and Remove Install interfaces. Since the Installer does not look at the target disk when calculating this value, it will almost always be overestimated. Common packages are only included once in the calculation, but for some scripts this may confuse more than help the user, so use the dontShowSelectedSizeInCustom flag to hide the field. Showing the field is the default action.
noSetupFunctionSupplied/setupFunctionSupplied
Specifies whether the Installer should call the setup function. The type and ID of the setup function code resource must be entered in the setup function fields when the setupFunctionSupplied flag is specified.
dontAllowServerAsTarget/dontAllowServerAsTarget
Specifies whether the Installer should allow the user to install onto AppleShare volumes. WARNING: This flag is an unsupported and untested feature, and is available only as a courtesy to those developers that have hacked previous versions of the Installer to gain this functionality. Only those scriptwriters that absolutely, positively, must allow their users to install onto AppleShare server volumes should use the allowServerAsTarget flag! You should never, ever install anything into the volume’s System Folder!
Field descriptions
Setup Function Code Resource Type
The resource type of the setup function code resource. This field is ignored unless the setupFunctionSupplied flag is specified. The type is usually ‘infn’. (4-bytes)
Setup Function Code Resource ID
The resource ID of the setup function code resource. This field is ignored unless the setupFunctionSupplied flag is specified. (2-bytes)
Help Page Four resource IDs of ‘PICT’ resources that make up one help page. ( Four 2-byte values )
Recommended Target Folder Name
The recommended target folder name. This can be specified at run-time by the scriptwriter in the setup function. As with any file name, the length should be limited to 31 characters, although the Installer will truncate the string if too long. (even-padded Pascal string)
Data Structures
The setup function is a code resource specified in the preference resource that is passed a pointer to a parameter block with information about the Installer’s environment. The entry point of this code resource must have the interface:
Return the result code noErr to have the Installer continue as normal. Return the result code kQuitInstallerNow to force the Installer to quit immediately. Returning any other value will cause an error alert to be display before forcing the Installer to quit.
The parameter block contains the Installer’s suggested target application folder and system disk. The fields in the parameter block can be changed to override the suggested values.
typedef struct {
—> ProcPtr fCallBackProcPtr;
<—> FSSpec fTargetFSSpec;
<—> short fSystemVRefNum;
} EnvironmentSetupPB, *EnvironmentSetupPBPtr;
Field descriptions
fCallBackProcPtr A pointer to the Installer’s dispatch routine. You’ll need to pass this field as a parameter to Installer function glue routines.
fTargetFSSpec Contains the Installer’s suggested target folder information. You can choose to override this suggestion by changing any of the fields in the FSSPec structure. If the useDiskTargetMode flag is specified in the preference resource, only the vRefNum field of fTargetFSSpec is used by the Installer.
fSystemVRefNum The fSystemVRefNum field contains the Installer’s recommended System Folder volume. You can choose to override this suggestion by changing the value passed. This field is ignored when using the useDiskTargetMode flag because the system disk must always be the same as the target disk.
Packages and Atoms
This chapter describes how to use packages and atoms.
About Packages (‘inpk’)
The package is added to the Custom Install list using the AddCustomItem rule clause, and if selected when clicking the Install or Remove button, will be added to the list of packages to install/remove. For an Easy Install, the Installer rule clause AddPackages is used to build up the list of packages that the Installer will use to perform the bulk of the installation.
Using Packages
Packages group atoms to make scripting easier, and to provide the hierarchical list in the Custom Install dialog. The package contains a list of those atoms and other packages that should be installed or removed when the parent package is installed or removed.
Using Packages with Easy Install
One of the goals of the Easy Install rules is to specify the packages that will be installed when the user clicks the Install button. Your Easy Install rules should eventually call the AddPackages rule clause to specify the packages, and ultimately the atoms, to be installed. During an easy installation, the Installer is only concerned with the parts list and the restart flag. The other fields are currently used only in the Custom Install and Remove interface.
Using Packages with Custom Install and Remove
Packages are the foundation for the selectable items the user can choose from in the Custom Install list. Packages are included at the top-level of the list by calling the AddCustomItem rule clause from the Custom Install rules. The specified packages will then be displayed in the list with any nested packages (with their showsOnCustom flag set) shown as selectable sub-packages. It is then up to the user to select the desired packages and click the Install or Remove button.
To aid the user in deciding which items to select, an optional Get Info-style window can be supplied by scriptwriter that provides the icon, total size, version, date and information text. To enable the Get Info window for the item, you need only to create a Package Comment resource (‘icmt’) and reference this from the package.
Atom Execution Order
Once the user clicks the Install or Remove button all specified packages are decomposed into a flat list of atoms. Therefore, the order the Installer executes the atoms is unrelated to their position in the package’s part list. Prior to installation the Installer groups File, Resource, Font, ResMerge, and Folder Atoms based on the source disk they reference. Those atoms that do not need source disks (atoms that delete on install) are grouped together.
For each source disk the Installer executes the atoms in the following order:
n Folder Atoms.
n File Atoms. This allows you to overwrite a file copied with a Folder Atom on the same or previous source disk.
n ResMerge Atoms. This allows you to add or replace additional resources to a file copied on the same or previous source disk.
n Resource Atoms. This allows you to add or replace a resource in a file copied with a Folder, File or ResMerge Atom on the same or previous source disk.
n Font Atoms.
Although the Installer will consistently order the atoms of a specific type, the scriptwriter should never depend on this ordering, except for Action Atoms which are always guaranteed to be ordered by their ‘inaa’ resource ID.
To ensure that the source disks will always be copied in the same order, include a Disk Order resource (‘indo’) in your script.
Package Reference
Package Resource Description
Packages have an 'inpk' resource type. Its template is shown below.
#define PackageFlags \
boolean doesntShowOnCustom, showsOnCustom; \
boolean notRemovable, removable; \
boolean forceRestart, dontForceRestart; \
fill bit[13] /* Reserved */
type 'inpk' {
switch {
case format0:
key integer = 0; /* Package Format version */
PackageFlags; /* Package Flags */
unsigned integer; /* Package Comment Rsrc ID */
unsigned longint; /* Package Size */
EvenPaddedString; /* Package Name */
unsigned integer = $$CountOf(PartsList);
wide array PartsList { /* Parts List */
RsrcType; /* Part Type */
RsrcID; /* Part ID */
};
};
};
Flag descriptions
showsOnCustom/doesntShowOnCustom
Determines if the package should be displayed in the Custom Install list.
removable/notRemovable Determines if the package should be added to the list of packages to be removed when the user has clicked the Remove button. When used with the showsOnCustom flag, determines if the package is selectable in the Custom Remove list. Note that you must also set the deleteWhenRemoving flag on any File, Resource or Font Atoms that are to be removed and you must set the actOnRemove flag in any Action Atoms that are to be called.
To include an package as a selectable item within Custom Remove, it is necessary to also include the package as a selectable item in Custom Install. There is no option to display a package as a selectable item in Custom Remove, but not in Custom Install. You may however choose to do nothing if the package is a selected item within Custom Install, and only act on that selected package during Custom Remove, but this may be confusing to the user.
forceRestart/dontForceRestart
Determines if the Installer should force the user to restart their Macintosh after installing or removing this package when the currently active System Folder is a target. Use the forceRestart flag if the installation requires rebooting to gain functionality, or if the package makes changes to the System file.
Field descriptions
Package Comment Rsrc ID
The resource ID of a package comment resource that displays the package’s size, date, version and a brief description of its contents or what it does. It’s recommended that every package shown in the Custom Install list have a comment resource. If you do not wish to provide a package comment, place a zero in this field. There are two types of comment resources. The first, an ‘icmt’ resource, provides basic information in one resource. The newer ‘inpc’ resource supports the RAM Size field and references a ‘TEXT’ resource that allows up to 32K of information text. (2-bytes)
Package Size The size of all atoms and packages contained in this package. This value is used to display in the comment window as well as provide the estimated selection size provided in Custom Install. The Installer does not use this field to determine the actual disk space requirements of the target hard disk during preflighting. Individual atom sizes are summed to determine if sufficient target disk space is available. (4-bytes)
Package Name The name to be displayed in the Custom Install list. (even-padded Pascal string)
If the Package Name field is a single dash character (-), a gray horizontal line appears in the list of packages. This dash line is similar to the one found for menu resources. This line can be used to separate the items which can be installed into logical groups. If a package is used just for displaying a separation line, all of the other fields are ignored.
Below is a sample gray-line package:
resource 'inpk' (1, "dashed line") {
format0 {
showsOnCustom,
notRemovable,
dontForceRestart,
0, /* Pkg Cmnt Rsrc ID */
0, /* Package size */
"-", /* Package Name */
{} /* empty brackets */
}
};
Part List The type and resource ID of each part contained in this package. (4-bytes + 2-bytes for each list item)
Package Comment Resource Description
Visible packages should reference one of two comment resources to provide additional information to the user about the packages they might want to install or remove. The older ‘icmt’ is supported, but cannot specify the RAM Size field. The new ‘inpc’ comment resource must reference a ‘TEXT’ resource that contains the text to display at the bottom of the package info window. Both templates are described below.
Custom Item Date The release date of the package. The value is specified in seconds since January 1, 1904. The Installer uses the IUDateString toolbox call to get the string to display. See Inside Macintosh Volume II, page 377 and Inside Macintosh Volume I, page 504. (4-bytes)
Custom Item Version The version number of this package. The Installer can decipher two version formats:
Binary coded decimal number. The ones digit is the secondary revision (0 to 9), the tens digit is the primary revision (0 to 9), and all greater digits make up the version number. For example, 100 is version 1.0, 290 is version 2.9, 605 is version 6.0.5, and 5704 is version 57.0.4. The Installer knows this format because it will always be less than 10000. (4-bytes)
‘vers’ resource hexadecimal number. See the definition of ‘Version’ in the “InstallerTypes.r” file. (4-bytes)
Custom Item RAM Requirements
The estimated RAM needs of this package. The Installer displays this value in the package information window. (4-bytes)
Custom Item Icon ID The ID of the appropriate ICON, ICN#, icl4 and/or icl8 resources. The ID must be 1024 or greater (IDs below this range are reserved). If the script contains these icons, the appropriate one is displayed in the upper left corner of the package information window. (2-bytes)
Custom Item Description
The ID of a ‘TEXT’ resource containing the text to appear in the comment section of the package information window. It should describe the package and provide any information that will help the user decide if installing or removing the package is appropriate. Styled text is not currently supported. (2-bytes)
Old Package Comment Resource Description
type 'icmt' {
unsigned hex longint; /* Release Date */
unsigned hex longint; /* Version Number*/
RsrcID; /* Icon ID */
EvenPaddedString; /* Package Comment Text */
};
Field descriptions
Release Date The release date of the package. The value is specified in seconds since January 1, 1904. The Installer uses the IUDateString toolbox call to get the string to display. See Inside Macintosh Volume II, page 377 and Inside Macintosh Volume I, page 504. (4-bytes)
Version Number The version number of this package. The Installer can decipher two version formats:
Binary coded decimal number. The ones digit is the secondary revision (0 to 9), the tens digit is the primary revision (0 to 9), and all greater digits make up the version number. For example, 100 is version 1.0, 290 is version 2.9, 605 is version 6.0.5, and 5704 is version 57.0.4. The Installer knows this format because it will always be less than 10000. (4-bytes)
‘vers’ resource hexadecimal number. See the definition of ‘Version’ in the “InstallerTypes.r” file. (4-bytes)
Icon ID The ID of the appropriate ICON, ICN#, icl4 and/or icl8 resources. The ID must be 1024 or greater (IDs below this range are reserved). If the script contains these icons, the appropriate one is displayed in the upper left corner of the Package Comment window. (2-bytes)
Package Comment Text The text which appears in the comment section of the Package Comment. It should describe the package and provide any information that will help the user decide if installing or removing the package is appropriate. (even-padded Pascal string)
About the File Atom
The File Atom should be used to copy or delete one or both forks of a file. Two versions of the File Atom script resource are understood by Installer 4.0, but it is recommended that you use format version 1.
The File Atom provides the following major features for copying or deleting files:
n Ability to update a file only if it already exists.
n Ability to preserve an existing file.
n Ability to preserve a newer file based on its creation date, ‘vers’ 1 resource or custom code you write.
n Decompression of a file during installation.
n Automatically unlock the file before replacing or deleting, and/or lock the file when the installation is finished.
n Install a file that has been split among multiple source disks.
If you are simply copying hundreds of uncompressed files and do not wish to create separate Files Atoms for each, you might be able to use a Folder Atom instead.
Using the File Atom (‘infa’)
The new version of the File Atom provides for large source files to be split across installation disks, then joined into one file on the target disk during the installation. In addition, compressed source files can be decompressed during the installation using an Atom Extender.
Comparing Files by Version
Two new fields in the File Atom allow the scriptwriter to compare the source and target file using their version number, instead of only using their creation date. The first field holds the source file’s version number, and the second field holds the resource ID of a new Version Compare (‘invc’) script resource. The Version Compare script resource allows the scriptwriter to call a code resource that calculates the version number of the target file.
To compare the newness of the target and source using the old creation date method, use the useSrcCrDateToCompare flag. To compare using the version number in the target’s ‘vers’ ID=1 resource then use the useVersProcToCompare flag and place a 0 (zero) in the Version Compare Rsrc ID field. If the version number is stored somewhere besides the ‘vers’ ID=1 resource then you’ll need to create and attach a Version Compare script resource to the File Atom.
Using either the useSrcCrDateToCompare or useVersProcToCompare flag presents the identical interface to the user if the source file is older than the target file. See the description of the leaveAloneIfNewer flag in the “File Atom Reference” section.
Using Split Sources with File Atoms
The new ‘infa’ script resource contains a source list that holds zero or more references to source files. If the original source file must be split into smaller files, an entry for each split source piece should be placed into the source list. Each entry contains information about the location of the source file (‘infs’ ID), the target size of the resource fork piece and the target size of the data fork piece.
Each target size field must contain the exact size the source piece will appear in the target file. If the piece is being decompressed with an Atom Extender during installation, then this field must contain the uncompressed size of the piece. If only one fork is requested to be copied, the target size field of the other fork is ignored. Place a zero in a fork’s target size field if the fork contains no data.
NOTE
The order of the entries in the source list is important. Each piece will be written to the target file in the same order as it appears in the list. u
Using Atom Extenders with File Atoms
Using Atom Extenders with the new File Atom (Format 1) allows scriptwriters to easily decompress files that have been compressed on the source installation disk. Attach the Atom Extender to the File Atom file by entering the ID of the ‘inex’ script resource into the appropriate field in the ‘infa’. The code resource referenced from the ‘inex’ script resource will be called at the desired point in the installation so it can read the compressed file data, decompress the data, then write it to the target file.
NOTE
You should never create a source file that has a compressed resource fork, because any attempt to access the resource fork by the Finder or other application may crash the Macintosh. The rsrcForkInRsrcFork/rsrcForkInDataFork flag has been added to designate where the resource fork is stored. Use the rsrcForkInDataFork flag when copying a compressed resource fork that is stored in the data fork of the source file. Use the rsrcForkInRsrcFork flag when copying a non-compressed resource fork. u
When the Installer is preparing to install, each File Atom is expanded into one or more parts. As each part is installed, the Atom Extender attached to the original File Atom will be called for each part. When only one source file is specified there is one part for each fork being copied. When split source pieces are specified there is one part for each fork being copied from each piece.
The goal of the new File Atom and Atom Extender is to provide compatibility with most popular compressed source file configurations. Several configurations are listed below.
n The simplest source file configuration is for each compressed fork to be placed into the data fork of two separate files. The Installer will call the Atom Extender separately for each fork.
n Another source file configuration places both forks into the same data fork of a source file, with a header describing the format of the data. The Atom Extender will be called once for each fork copied, but will be responsible for finding, reading and writing the correct data for the specified fork. The Atom Extender parameter block will provide information about which fork is being copied.
n An “Archived” source file configuration contains multiple compressed files (and forks) in one source file. One File Atom must be created for each target file being copied, with each referring to the same source file (‘infs’). The Atom Extender parameter block will contain information about the current file (and fork) being copied, with which the Atom Extender will find, read, decompress and write the proper target file’s data. Our InstaCompOne Atom Extender is an example of this approach.
For those source configurations that cannot be accommodated by the built-in routines, scriptwriters can use the supplied parameter block to perform the copy by themselves. This strategy should only be taken when absolutely necessary.
Installing a Custom Folder Icon
The File Atom can easily be used to set the custom icon of any folder on the target disk. The Installer notices if the scriptwriter is copying the special invisible “Icon\n” file, and if so automatically sets the userCustomIcon bit on its parent folder.
There are several key points to remember when installing a custom icon:
n Since the Installer does not remove the special “Icon\n” file correctly, use the dontDeleteWhenRemoving flag to prevent its removal.
n It’s polite to preserve an existing custom icon, so use the copyIfUpdate flag.
n The Installer will install the custom icon even if the directory is the root level of the hard disk. We discourage scriptwriters from recommending the root level of the hard disk as the target folder, but user’s can select it if they choose.
File Atom Reference
This section describes the resource description of the ‘infa’ resource, format 1.
integer = $$CountOf (Pieces); /* Number of Source Pieces */
wide array Pieces {
fileSpecID; /* Source File Spec*/
unsigned longInt; /* Target Data Fork Part Size */
unsigned longInt; /* Target Rsrc Fork Part Size */
};
unsigned longint; /* Source Version Number */
rsrcID; /* Version Compare Rsrc ID */
rsrcID; /* Atom Extender Rsrc ID */
evenPaddedString; /* Atom Description */
};
};
Flag Descriptions
deleteWhenRemoving/dontDeleteWhenRemoving
Determines if the file is deleted during a removal. When using the deleteWhenRemoving flag, if the target file exists and the user clicks Remove, the target file is deleted. If the file does not exist on the target disk, this flag is ignored. The file atom must be part of a package that uses the removable flag. Note that of the following File Atom flags, only the rsrcFork/noRsrcFork and dataFork/noDataFork flags have any effect on the removal process.
deleteWhenInstalling/dontDeleteWhenInstalling
Determines if a file is deleted during an installation when using the dontCopy flag. Installer generally ignores this flag when using the copy flag. When using the deleteWhenInstalling flag, after the user clicks Install, the target file is deleted if it exists, otherwise the flag is ignored. The deleteWhenInstalling flag is primarily used for deleting previously installed files that are no longer needed.
copy/dontCopy Determines if the file is copied during an installation. Note that some flags (leaveAloneIfNewer, keepExisting, copyIfUpdate) can prevent copying from happening under the circumstances specified.
dontIgnoreLockedFile/ignoreLockedFile
Determines if an existing locked target file should be automatically unlocked before replacing. Only use the ignoreLockedFile flag if you originally installed the file locked or your software locks the file. Use the dontIgnoreLockedFile flag the majority of times to preserve the user’s control over their Macintosh.
dontSetFileLocked/setFileLocked
Determines if the target file should be locked after copying. Use setFileLocked to request that the target file be locked at the end of the installation.
useSrcCrDateToCompare/useVersProcToCompare
Determines how the Installer will determine if the target file is newer or older than the source file. If using the useSrcCrDateToCompare flag the creation date entered in the Source File Spec is compared with the creation date of the target file. If the useVersProcToCompare flag is used, an optionally supplied version function is called to determine the version number of the target file. See the description of the Version Compare Rsrc ID field.
srcNeedExist/srcNeedNotExist
Determines whether the source file must exist on the source disk. Use srcNeedNotExist if the source file can optionally reside on the source disk. If the file is not found the atom is ignored and the installation continues.
rsrcForkInRsrcFork/rsrcForkInDataFork
Since a compressed resource fork should never be left in the resource fork of the source file, this allows the scriptwriter to easily store the compressed resource fork in the data fork. These flags determine where the resource fork data will be read from when using the ReadSourceData() routine. If the rsrcForkInDataFork flag is specified, the source data will actually be read from the data fork.
leaveAloneIfNewer/updateEvenIfNewer
Determines what action the Installer should take if the target file is newer than the source file that is replacing it. The method the Installer uses to determine the newness of the files is based on the useSrcCrDateToCompare and useVersProcToCompare flags. Use the updateEvenIfNewer flag if the version of this file must be synchronized with specific versions of other files that are part of the installation. The alert displayed to the user depends whether the user is performing an Easy Install or a Custom Install.
Easy Install — If using the leaveAloneIfNewer flag, the user will not be notified and the newer will be preserved. If using the updateEvenIfNewer flag, an alert is shown that has two options: Continue or Cancel. Clicking Cancel will stop the installation, and clicking Continue will replace the newer target file with the older source file.
Custom Install — If using the leaveAloneIfNewer flag, the user will be presented with an alert that provides three choices: Newer, Older or Cancel. If using the updateEvenIfNewer flag, the alert is the same as for an Easy Install.
keepExisting/updateExisting
Allows the scriptwriter to preserve an existing file when using the copy and/or deleteOnInstall flag. This might be the case if you want to preserve a preference file that contains user specific data. Use keepExisting to prevent the Installer from disturbing an existing target file. No copying will occur if the updateExisting flag is used with the copyIfUpdate flag.
copyIfUpdate/copyIfNewOrUpdate
Allows the scriptwriter to update a file only if it already exists when used with the copy flag. Use copyIfUpdate to prevent a new file from being created. If the copyIfUpdate flag is used with the keepExisting flag then no copying will occur.
rsrcFork/noRsrcFork Determines if the resource fork of the file is affected during an installation or removal. Use resourceFork to copy or delete the entire resource fork of the file during an installation, or delete the entire resource fork during a removal. Use noResourceFork to not touch the resource fork of the file.
dataFork/noDataFork Determines if the data fork of the file is affected during an installation or removal. Use dataFork to copy or delete the entire data fork of the file during an installation, or delete the entire data fork during a removal. Use noDataFork to not touch the data fork of the file.
Field Descriptions
Total Target File Size The size in bytes of the file to be installed or deleted. This field is only used by the Installer in figuring the disk size needed for an installation. (4-bytes)
Finder Attribute Flags
These flags determine how Finder displays and manages user interaction with the file. If you are using ScriptCheck 4.0, then this field is updated automatically (see ScriptCheck documentation for handling compressed source files), otherwise you must place the correct value in this field. See Inside Macintoh, Volume VI, pages 9-36 - 9-38 for more information about these flags. (2-bytes)
Source File Spec. Rsrc ID
The resource ID of a Source File Spec. (‘infs’) describing the source file where the data is stored. If you’re just deleting a file and therefore don’t need a source file, enter 0 (zero) in this field. (2-bytes)
Target Data Fork Piece Size
The number of bytes the data fork piece will occupy in the target file. If the data fork is decompressed using an Atom Extender during the installation, then this value should be the original noncompressed size of the source piece. The value is used to compute where multiple pieces are to be written into the final target file, and therefore must be exact. If not copying the data fork, this field is ignored. (4-bytes)
Target Rsrc Fork Piece Size
The number of bytes the resource fork piece will occupy in the target file. If not copying the resource fork, this field is ignored. If the resource fork is decompressed using an Atom Extender during the installation, then this value should be the original noncompressed size of the source piece. The value is used to compute where multiple pieces are to be written into the final target file, and therefore must be exact. (4-bytes)
Source Version Number The version number (BCD format) of the source file when using the useVersProcToCompare flag. See Inside Macintosh: Macintosh Toolbox Essentials, page 7-31 for a description of the version number format. (4-bytes)
Version Compare Rsrc ID The resource ID of a Version Compare (‘invc’) script resource. The resulting version number from the version function will be compared with the Version Number field to determine if the target is newer or older than the source. If the resource ID is 0 (zero) and the useVersProcToCompare flag is used the Installer will default to comparing the Source Version Number field with the version number in the ‘vers’ ID=1 resource contained in the target file. If no ‘vers’ ID=1 resource exists then the target version number is assumed to be 0 (zero). (2-bytes)
Atom Extender Rsrc ID The resource ID of an Atom Extender (‘inex’ script resource). (2-bytes)
File Atom Description The File Atom Description field is an even-padded Pascal string describing the atom. This is used as part of the status dialog. If you do not supply a description the Installer will display “Copying File: [file name]” or “Writing File: [file name].” If you supply a description it will be appended to the string “Copying “ or “Writing “.
About the Resource Atom (‘inra’)
The Resource Atom should be used to copy or delete a single resources in a file. Two versions of the Resource Atom script resource are understood by Installer 4.0, but it is recommended that you use format version 1.
The Resource Atom provides the following major features for copying or deleting files:
n Ability to update a resource only if it already exists.
n Ability to preserve an existing resource.
n Ability to preserve a newer resource based on its version number that is determined by custom code you write.
n Decompression of the resource during installation.
n Installation of a resource that has been split among multiple resources on multiple source disks.
If you must copy all the resources from a single source file and merge them with the target file you may want to consider using the ResMerge Atom.
Using the Resource Atom
Comparing Files By Version
Two new fields in the Resource Atom allow the scriptwriter to compare the source and target resource based on the version number. The first field holds the source file’s version number, and the second field holds the ID of a Version Compare (‘invc’) script resource. The Version Compare script resource allows the scriptwriter to call a code resource that calculates the version number of the target resource.
To compare the version number of the target resource to the source version number entered in the Resource Atom you’ll need to create and attach a Version Compare script resource to the Resource Atom. Since setting and obtaining version number information for an individual resource is not a feature of the Resource Manager, extracting the version number from the target resource depends on how the resource encodes its version number. Most examples of this use a header at the beginning of the resource to hold this type of information.
Using Split Sources with Resource Atoms
The format 1 version of the Resource Atom script resource contains a list of source entries. If the original resource must be split into smaller resource pieces, an entry for each split source piece must be placed into the source list. Each entry contains information about the location of the source file (‘infs’ ID), the source resource type, the source resource ID, the target size of the resource piece, and the source resource name. The target size field must contain the exact size the source piece will appear in the target resource. If the piece is being decompressed with an Atom Extender during installation, this field must contain the original uncompressed size of the piece.
When specifying more than one split resource piece, the Installer joins the pieces into a target resource in the order the sources are specified. Generally, you’ll want to use ‘part’ for the type of source resources that have been split and/or compressed. This prevents resources compressed using third-party schemes from being confused with the original resource, especially when using tools like ResEdit and DeRez.
Using Atom Extenders with Resource Atoms
You’ll use an Atom Extender to decompress a resource that was compressed by you to save space on your source disks. The Resource Atom is expanded into one or more parts that the Atom Extender receives with the kBeforePart and kAfterPart messages. There will be one part for each source resource piece specified in the source list. Since owned resources are always copied whole and are usually relatively small, the owner’s Atom Extender is never called when copying its owned resources.
NOTE
The compressed flag in the resource attributes should NOT be set on any source resource being decompressed using an Atom Extender. This flag is presently reserved for use by Apple Computer, Inc. u
Resource Atom Reference
This section describes the resource description of the ‘inra’ resource, format 1.
integer = $$CountOf (Parts); /* Number of Pieces */
wide array Parts {
fileSpecID; /* Source Piece File Spec */
rsrcType; /* Source Piece Type */
rsrcID; /* Source Piece Rsrc ID */
unsigned longInt; /* Target Piece Size */
evenPaddedString /* Source Piece Rsrc Name */
}
unsigned longint; /* Source Version Number */
rsrcID; /* Version Compare Rsrc ID */
rsrcID; /* Atom Extender Rsrc ID */
evenPaddedString; /* Atom Description */
};
};
Flag Descriptions
deleteWhenRemoving/dontDeleteWhenRemoving
Determines if the resource is deleted during a removal. When using the deleteWhenRemoving flag, if the target resource exists and the user clicks Remove, the target resource is deleted. If the resource does not exist on the target disk, this flag is ignored. Note that the Resource Atom must be part of a package that uses the removable flag.
deleteWhenInstalling/dontDeleteWhenInstalling
Determines if the resource is deleted during an installation when using the dontCopy flag. When using the deleteWhenInstalling flag, after the user clicks Install, the target resource is deleted if it exists, otherwise the flag is ignored. The deleteWhenInstalling flag is primarily used for deleting previously installed resources that are no longer needed. Note that some flags (leaveAloneIfNewer, keepExisting) can prevent deletion from happening under the circumstances specified.
copy/dontCopy Determines if the resource is copied or not during an installation. Note that some flags (leaveAloneIfNewer, keepExisting, copyIfUpdate) can prevent copying from happening under the circumstances specified.
leaveAloneIfNewer/updateEvenIfNewer
Determines what action the Installer should take if the target resource is newer than the source resource that is replacing it. The scriptwriter must write a code resource that determines the version number by referencing the resource ID of a Version Compare (‘invc’) script resource. Use the leaveAloneIfNewer flag to prevent the older source resource from replacing the newer target resource during an installation. Unlike the File Atom, the user is not given a chance to override the result of this flag. Use the updateEvenIfNewer flag if the version of this resource must be synchronized with specific versions of other files or resources that are part of the installation.
tgtRequired/noTgtRequired
The target file for this resource must already exist. If the target file does not exist, the user is warned that a target file is needed. (For example, AppleShare installs resources into the System file, but if there is no system file, the Installer alerts the user, rather than creating a System file which has only the AppleShare resources in it.) When using the noTgtRequired flag and the target file does not exist, the Installer will create one.
keepExisting/updateExisting
Allows the scriptwriter to preserve an existing resource when using the copy and/or deleteOnInstall flag. This might be the case if you want to preserve a preference resource that contains user specific data. Use keepExisting to prevent the Installer from disturbing an existing target resource. No copying will occur if the updateExisting flag is used with the copyIfUpdate flag.
copyIfUpdate/copyIfNewOrUpdate
Allows the scriptwriter to update a resource only if it already exists. Use the copyIfUpdate flag to prevent a new resource from being created. If the copyIfUpdate flag is used with the keepExisting flag then no copying will occur.
ignoreProtection/dontIgnoreProtection
Determines if the user should be alerted if any resource with its protected bit set will be replaced or deleted. When using the ignoreProtection flag the resource is deleted from or updated in the target file even if it is protected in the target file.
srcNeedExist/srcNeedNotExist
Determines whether the source resources must exist on the source disk. Use the srcNeedNotExist flag if the source resources can optionally reside on the source disk. If the source file or source resources are not found, the atom it is ignored and the installation continues normally.
byID/byName Determines how the resource should be found in the source and target files. If using the byID flag the resource is found in the source and target file using only the ID. If you want to require the resource name to match as well then use the nameMustMatch flag. If using the byName flag the resource is found in the source and target file using only the name specified in the Resource Name field. Use the byName flag when installing Desk Accessory resources in pre-7.0 System files.
nameMustMatch/nameNeedNotMatch
Specifies that the resource found in the source file using its ID have the name in the Resource Name field. The resource with the same name and ID in the target file, if any, will be replaced or deleted (if the updateExisting flag is used). This flag is ignored if the byName flag, above, is used. If using the nameNeedNotMatch flag the byID flag must also be used.
Field Descriptions
Total Target Size The size in bytes of the copied target resource and all its owned resources. This field is used only by the Installer in figuring the disk size needed for an installation. (4-bytes)
Target Resource File Spec.
The resource ID of a Target File Spec script resource (‘intf’, or ‘infs’ for pre-4,0 scripts) describing the file on the target disk where the resource will be deleted, created, or updated. (2-bytes)
Target Resource Type The resource type the Installer will use to find or create the resource in the target file. (4-bytes)
Target Resource ID The resource ID the Installer will use to find or create the resource in the target file. If the ID of the resource doesn’t matter and you’re copying using the byName flag (e.g., most Desk Accessories), this field should be 0, in which case the Installer picks an ID for the resource in the target file. (2-bytes)
Target Resource Attributes
The attributes that will be given to the target resource when copying. (2-bytes)
Target Resource Name The name that will be given to the target resource. If this string is empty, the name of the first source resource will be given to the target resource. (even-padded Pascal string)
Source Piece File Spec. The resource ID of a Source File Spec. (‘infs’) describing the source file that holds the resource part. If you’re just deleting a resource and therefore don’t need a source file, leave the source list empty. (2-bytes)
Source Piece Type The resource type of the resource piece being copied. If there is more then one piece, it’s recommended that the type by ‘part’. (4-bytes)
Source Piece ID The resource ID of the resource piece being copied. This field is ignored if the resource piece is being found by name (byName flag is used). (2-bytes)
Target Piece Size The number of bytes the resource piece will occupy in the target file. If the resource will be decompressed using an Atom Extender, then this value should be the noncompressed size of the source piece. This value is used to compute where multiple pieces are to be written in the final target file, and therefore must be exact. (4-bytes)
Source Piece Resource Name
The name of the source resource. This field is only needed when finding the source resource by its resource name (byName flag is used). (even-padded Pascal string)
Source Version Number The version number (BCD format) of the source resource when a Version Compare function is used to calculate the target version number. (4-bytes)
Version Compare Rsrc ID The resource ID of a Version Compare (‘invc’) script resource. The resulting version number from the version function will be compared with the Source Version Number field to determine if the target is newer or older than the source. If this field is 0 (zero) then the target version number is assumed to be 0 (zero). (2-bytes)
Atom Extender Rsrc ID The resource ID of an Atom Extender (‘inex’) script resource. This Atom Extender will be called during copying of each resource part. (2-bytes)
When using InstaCompOne compression enter a value of 241 here.
Resource Atom Description
The Resource Atom Description field is an even-padded Pascal string describing the atom. This is used as part of the status dialog. If you do not supply a description the Installer will display “Building File: [file name]” or “Writing File: [file name].” If you supply a description it will be appended to the string “Building “ or “Writing “.
About the Resource List Atom (‘inr#’)
The Resource List Atom is a unique atom that provides a more compact storage structure with slightly reduced functionality for installing resources. This enables scriptwriters to copy thousands of individual resources without the overhead of thousands of Resource Atom resources in their script file. For installation of less than a 100 resources, most scriptwriters should continue using individual Resource Atoms.
Using the Resource List Atom
The Resource List Atom is actually an array of individual Resource Atom records. The records are of a fixed size, so some options available in format 1 of the Resource Atom are not available in the Resource List Atom.
Use format1 Resource Atoms instead of the Resource List Atom if you need any of the following features:
n Find a source resource based on its name.
n Copy a resource that is split across multiple files.
n Specify a target resource name.
n Use with InstaCompOne decompression Atom Extender.
n Change the type or ID during installation. The Resource List Atom requires the target resource type and ID to be the same as the source resource type and ID.
Referencing Resource Atom Lists from Packages
Unlike other atoms, Resource Atom Lists are not referenced using their own atom type (‘inr#’). Instead, packages should reference the atom type ‘inra’ and the ID entered in the Resource ID field of the resource atom record inside the Resource Atom List array. When an ‘inra’ is found referenced from a package, the Installer first looks for a Resource List Atom (‘inr#’) resource, and if not found looks for an actual resource of type ‘inra’ and the specified ID in script file. When the Resource List Atom resource is found, the Installer searches through the list looking for a resource record that matches the requested resource ID. The Resource ID field in the record holds a 2-byte value that you create.
Resource List Atom Reference
This section describes the resource description of the ‘inr#’ resource, format 0.
Resource Description
type 'inr#' {
switch {
case format0:
key integer = 0; /* Resource Atom Format version */
integer = $$CountOf (inraRsrcs); /* Number of inraRsrcs */
wide array inraRsrcs {
integer; /* Resource ID */
resourceAtomFlagsFormat1; /* Resource Atom Flags */
unsigned longInt; /* Total Target Size */
fileSpecID; /* Target File Spec */
fileSpecID; /* Source File Spec */
rsrcType; /* Src/Tgt Rsrc Type */
rsrcID; /* Src/Tgt Rsrc ID */
integer; /* Tgt Rsrc Attributes */
unsigned longint; /* Source Version Number */
rsrcID; /* Version Compare Rsrc ID */
rsrcID; /* Atom Extender ID */
unsigned longInt; /* Target Size of Rsrc */
};
};
};
Flag Descriptions
The flags for the Resource List Atom are identical to format 1 of the Resource Atom. Since there is no source name field in the Resource List Atom you should always use the byID and nameNeedNotMatch flags.
Field Descriptions
Resource ID The ID value that will be used to find this record from the reference in a package. For example, if you choose the ID value of 369, then the reference from a package should have the type ‘inra’ and the ID 369. (4-bytes)
Total Target Size The size, in bytes, of the copied target resource and all its owned resources. This field is only used by the Installer for calculating the disk size needed for an installation. (4-bytes)
Target File Spec. The resource ID of a Target File Spec script resource (‘intf’, or ‘infs’ for pre-4,0 scripts) describing the file on the target disk where the resource will be deleted, created, or updated. (2-bytes)
Source File Spec. The resource ID of a Source File Spec. (‘infs’) describing the source file that holds the source resource. If you’re just deleting a resource and therefore don’t need a source file, place a 0 (zero) in this field. (2-bytes)
Src/Tgt Resource Type The resource type the Installer will use to find the resource in the target and source file. If the resource must be created in the target file it will be given this type. (4-bytes)
Src/Tgt Resource ID The resource ID the Installer will use to find the resource in the target and source file. If the resource must be created in the target file it will be given this ID. (2-bytes)
Target Resource Attributes
The attributes that will be given to the target resource when copying. (2-bytes)
Source Version Number The version number (BCD format) of the source resource when a Version Compare function is used to calculate the target version number. (4-bytes)
Version Compare Rsrc ID The resource ID of a Version Compare (‘invc’) script resource. The resulting version number from the Version Compare function will be compared with the Source Version Number field to determine if the target is newer or older than the source. If this field is 0 (zero) then the target version number is assumed to be 0 (zero). (2-bytes)
Atom Extender Rsrc ID The resource ID of an Atom Extender (‘inex’) script resource. This Atom Extender will be called during copying of each resource. (2-bytes)
Target Size The size in bytes of the copied target resource item. This field is used only by the Installer in figuring the disk size needed for an installation. (4-bytes)
About the Font Atom (‘inff’)
The Font Atom is used to describe a set of font strikes (size/style) from a specified font family which should be copied to or removed from a file. Two versions of the Resource Atom script resource are understood by Installer 4.0, but it is recommended that you use format version 1.
The Font Atom provides the following major features for copying or deleting fonts:
n Ability to preserve an existing font strike.
n Ability to specify an individual strike to copy/delete or simple mode that copies the complete family.
n Support for installing into all versions of System Software with a single Font Atom.
n Decompression of font resources (‘NFNT’, ‘sfnt’ or ‘FONT’) during installation.
n Installation of a font strike that has been split among multiple resources on multiple source disks.
Using the Font Atom
Auto-Routing Under Pre-7.1 Systems
To overcome the effort involved with installing fonts into the various versions of System Software, the Installer will automatically place the font resources into the System file if installing into a System Folder that does not support the “Fonts” folder. To use this feature, write your script to always install into a file in the System Folder’s “Fonts” folder. Make the target file path start with the reserved folder name “special-font” and reference this target file spec. from the Font Atom, and the Installer will handle the rest.
NOTE
System Software installation scriptwriters should understand how the Installer decides where the font resources will be installed to avert disasters, and bugs. The Installer uses the version of the target System file and the existence of a Resource Atom installing the ‘fld#’ resource to decide whether to auto-route or not. You must be installing a ‘fld#’ resource into a pre-7.1 System file at the same time as the fonts to let the Installer know you are upgrading to System 7.1 or newer. u
Using Atom Extenders with Font Atoms
You’ll use an Atom Extender to decompress font resources that were compressed by you to save space on your source disks. Minor constraints are required when using the Font Atom with this feature.
Scriptwriters must specify individual strikes(size and style) to copy when using an Atom Extender to decompress font resources. This is required because the target piece sizes for each strike must be entered in the optional source list. It’s recommended to place compressed font resource data into resources of type ‘part’.
The Font Atom is expanded into one or more parts that the Atom Extender receives with the kBeforePart and kAfterPart messages. As each part is installed, the Atom Extender attached to the original Font Atom will be called for each part. There will be a part for each source resource piece being copied. The only exception to this rule is for strikes that reference font resources in ROM. Since there is no data copied for these strikes the Atom Extender is not called.
NOTE
The ‘FOND’ resource is always copied using the Installer’s default copy mechanism. This prevents the scriptwriter from decompressing the ‘FOND’ resource using an Atom Extender. The ‘FOND’ resource is the road map to other font resources (‘FONT, ‘NFNT’, and ‘sfnt’), and therefore must never be compressed. We suggest that you convert the ‘FOND’ resource into the type ‘iFND’ and use the encodedFONDRsrc flag when compressing any of the font resources it references. This will prevent the system software from becoming confused when finding a ‘FOND’ resource in your source file that may reference not existent font resources. In addition, the compressed flag should NOT be set in the resource attributes of the ‘part’ resource because this flag is presently reserved for use by Apple Computer, Inc. u
Font Atom Reference
This section describes the resource description of the ‘inff’ script resource, format 1.
integer = $$CountOf (Pieces);/* Number of source pieces */ \
wide array Pieces{ \
RsrcSpec; /* Description of this piece*/ \
}
#define Strike \
integer; /* Font Size */ \
Style; /* Font Style */ \
RsrcType; /* Target Font Resource Type */ \
integer; /* Target Attributes */ \
SrcPartsList; /* Optional source pieces */
type 'inff' {
switch {
case format2:
key integer = 2; /*format version 2 */
fontFamilyAtomFlags; /* Font Atom Flags */
fileSpecID; /* Target File Spec */
fileSpecID; /* FOND Source File Spec */
integer; /* Target FOND Attributes */
unsigned longInt; /* Family Size */
rsrcID; /* Target Family Number */
switch {
case entireFamily:
key integer = 1;
case explicitFamilyMembers:
key integer = 2;
unsigned integer = $$CountOf(StrikeEntries);
wide array StrikeEntries {
Strike; /* Source for each of the strikes */
};
};
rsrcID; /* Atom Extender ID */
evenPaddedString; /* Atom Description */
evenPaddedString; /* Family Name */
};
};
Flag Descriptions
deleteWhenRemoving/dontDeleteWhenRemoving
Determines if specific font strikes or the entire family is deleted during a removal.
Using with explicitFamilyMembers copy option — When using the deleteWhenRemoving flag, if the target font strike exists and the user clicks Remove the strike is deleted. If a strike does not exist on the target disk, this flag is ignored. If all font strikes for a given family are removed, the family’s ‘FOND’ resource is also deleted.
Using with entireFamily copy option — When using the deleteWhenRemoving flag, the family’s ‘FOND’ resource and all font strikes for the family are deleted.
Note that the font atom must be part of a package that uses the removable flag.
deleteWhenInstalling/dontDeleteWhenInstalling
Determines if specific font strikes or the entire family is deleted during an installation when using the dontCopy flag.
Using with explicitFamilyMembers copy option — When using the deleteWhenRemoving flag, if the target font strike exists and the user clicks Remove the strike is deleted. If a strike does not exist on the target disk, this flag is ignored. If all font strikes for a given family are removed, the family’s ‘FOND’ resource is also deleted.
Using with entireFamily copy option — When using the deleteWhenRemoving flag, the family’s ‘FOND’ resource and all font strikes for the family are deleted.
The deleteWhenInstalling flag is primarily used for deleting previously installed font resources that are no longer needed.
copy/dontCopy Determines if the font resources are copied or not during an installation. Note that some flags (leaveAloneIfNewer, keepExisting, copyIfUpdate) can prevent copying from happening under the circumstances specified.
noEncodedFONDRsrc/encodedFONDRsrc
Allows ‘FOND’ resources to be encoded into the resource type ‘iFND’ when compessing the font resources. This is recommended to help prevent the system software from becoming confused when finding a ‘FOND’ resource in your source file that may reference not existent font resources.
tgtRequired/noTgtRequired
The target file must already exist. If the target file does not exist, the user is warned that a target file is needed. When using the noTgtRequired flag and the target file does not exist, the Installer will create one.
keepExisting/updateExisting
Allows the scriptwriter to preserve existing font resources when using the copy and/or deleteOnInstall flag. Use the keepExisting flag to prevent the Installer from disturbing an existing target font strike or family.
Using with explicitFamilyMembers copy option — When using the keepExisting flag and a specific strike in the ‘FOND’ resource already exists in the target file, it will not be replaced.
Using with entireFamily copy option — When using the keepExisting flag and the ‘FOND’ resource already exists, no strikes will be copied or replaced.
No copying will occur if the updateExisting flag is used with the copyIfUpdate flag.
copyIfUpdate/copyIfNewOrUpdate
Allows the scriptwriter to update a font resource only if it already exists. Use the copyIfUpdate flag to prevent a new resource from being created.
Using with explicitFamilyMembers copy option — When using the copyIfUpdate flag, a specific strike is copied to the target file only if the strike already exists in the target file.
Using with entireFamily copy option — The entire source font family will be copied if any strikes exist in the target file.
If the copyIfUpdate flag is used with the keepExisting flag, then no copying will occur.
ignoreProtection/dontIgnoreProtection
Determines if the user should be alerted if any font resource with its protected bit set will be replaced or deleted.
Using with explicitFamilyMembers copy option — When using the dontIgnoreProtection flag, if the ‘FOND’ resource or any font resource to be replaced has the protection flag set, the user will be alerted, and the installation will be canceled. Use the dontIgnoreProtection flag if preserving protected font resources is important. When using the ignoreProtection flag the font resources are deleted from or updated in the target file even if it any are protected in the target file.
Using with entireFamily copy option — When using the dontIgnoreProtection flag the user is alerted only if the ‘FOND’ resource is protected, but if any other font resources are protected, they will be replaced without alerting the user. When using the ignoreProtection flag the font resources are deleted from or updated in the target file even if it any are protected in the target file.
srcNeedExist/srcNeedNotExist
Determines whether the source font resources must exist on the source disk. Use the srcNeedNotExist flag if the source resources can optionally reside on the source disk. If the source file or source resources are not found, the atom it is ignored and the installation continues normally.
byID/byName Determines how the font strike resources should be found in the source files. If using the byID flag the font strike’s resources are found in the source file using only the ID. If you want to require the resource name to match as well then use the nameMustMatch flag. Note that the byID flag can only be used when installing using the explicitFamilyMembers copy option and split source resources are specified. If using the byName flag the font strike resources are found in the source file using only the name specified in the Source Piece Rsrc Name field.
nameMustMatch/nameNeedNotMatch
Specifies if the font strike resources found in the source file using their IDs must have the name in the Source Piece Rsrc Name field. Note that the nameMustMatch flag can only be used when installing using the explicitFamilyMembers copy option and split source resources are specified. This flag is ignored if the byName flag is used.
Field Descriptions
Target File Spec ID The resource ID of a Target File Spec script resource (‘intf’, or ‘infs’ for pre-4,0 scripts) describing the file on the target disk where the resource will be deleted, created, or updated. (2-bytes)
Source File Spec ID The resource ID of a Source File Spec script resource describing the file on the source disk that contains the 'FOND' resource to be copied into the target file.
Using with explicitFamilyMembers copy option — If no optional split source information is provided, the strikes specified must also be contained in the same file as the source ‘FOND’ resource. Optional split source information always overrides that default source for those strikes that use it.
Using with entireFamily copy option — The source strike resources referenced in the source 'FOND' resource must be contained in the same source file as the source 'FOND' resource.
If you’re just deleting strikes and therefore don’t need a source file, set this field to 0. (2-bytes)
Target FOND Attributes The resource attributes that will be given to the target 'FOND' resource during installation. See Inside Macintosh Vol. I, page 111 for more information about resource attributes. (2-bytes)
Font Family Size The size in bytes of all font resources including the 'FOND' resource to be installed or deleted. This field is used by the Installer in figuring the sizes for an installation. (4-bytes)
Target FOND ID The resource ID that will be given to the target 'FOND' resource. Normally, this ID should also be the same ID as the resource ID of the source 'FOND' resource. The Installer always sets the family number field contained in the ‘FOND’ resource to the resource ID of the ‘FOND’ when it is copied or updated. (2-bytes)
How-To-Copy Value Key Specifies how the font resources will be copied, or deleted. Currently, the two copy options are available: entireFamily Value (1), and explicitFamilyMembers Value (2). (2-bytes)
Using the entireFamily copy option — Tells the Installer that all strikes specified in the source 'FOND' resource will be copied. The 'FONT', 'NFNT', or 'sfnt' resources must exist in the same source file as the 'FOND' resource. The Copy Entire Family Value is provided to copy small, simple font families with minimal scripting effort. Since the target resource attributes cannot be specified, the target resource inherits the source's. If the Font Family Atom Flags are set for deleteWhenRemoving or deleteWhenInstalling & dontCopy the target 'FOND' resource and ALL of its referenced strikes will be deleted from the target file upon removal or installation. (2-bytes)
Using the explicitFamilyMembers copy option — Tells the Installer that one or more strikes are specified in the following member list. (2-bytes)
Point Size The family member's point size. (2-bytes)
Style Contains flags describing the style of the font. The style bits are defined below. (2-bytes)
Bit 0: Set for Bold
Bit 1: Set for Italic
Bit 2: Set for Underline
Bit 3: Set for Outline
Bit 4: Set for Shadow
Bit 5: Set for Condensed
Bit 6: Set for Extend
All other bits are reserved.
Resource Type The resource type of the target or source font resource. This will be the type of the font resource created by combining the split resources. If no split resource information is given, this field should be the type of the source font resource (e.g. 'FONT', 'NFNT', or 'sfnt'). (4-bytes)
Resource Attributes The resource attributes that will be given to the target font resource. The Split Resource list specifies one or more resources that make up the font resource when combined in the order listed. (2-bytes)
Split Resource File Spec ID
The Split Resource File Spec ID field is a 2-byte field that specifies the file on the source disk that contains the split resource to be combined. (2-bytes)
Split Resource Type The resource type of the source split resource. Usually, this should be type 'part'. (4-bytes)
Split Resource ID The resource ID of the source split resource. (2-bytes)
Split Resource Size The exact size in bytes of the source split resource. (4-bytes)
Split Resource Name The name of the source split resource. If the resource is being found using the byName flag, this field must be filled. To help ensure that the correct resource is being installed, the name of the resource in the source file must match this field if the resource is being found by name. (even-padded Pascal string)
Atom Extender ID The resource ID of an Atom Extender ‘inex’ script resource. This Atom Extender will be called during copying of each font resource part. (2-bytes)
Font Family Atom Description
A Pascal string describing the atom. This field is used as part of the status dialog. If this field is not empty, the status dialog displays “Reading <Description String>”, or “Writing <Description String>”. If this field is empty, the status dialog displays “Reading font: <Font Family Name>”, or “Writing font: <Font Family Name>”. (even-padded Pascal string)
Font Family Name The family name. The family name will be used to find the source and target 'FOND' resource. (even-padded Pascal string)
About the ResMerge Atom (‘inrm’)
The ResMerge Atom can be used to copy all resources from a source file to a target file. Each resource is copied separately, replacing an existing resource of the same type and ID. Because the ResMerge Atom offers no options, you may find that you will need to use individual Resource Atoms to handle special situations.
The ResMerge Atom is unique from using Resource Atoms because anyone can add to or delete resources from the source file without changing the atom. This is acceptable as long as the Installer can successfully preflight the required disk space. A field in the atom holds the total size the resources expect to occupy in the target file. This flexibility comes at a cost to ease of use because the Installer cannot determine during preflighting how many resources will be replaced, thus not requiring additional disk space. We will therefore usually overestimate the required disk space, forcing the user to make more space available than will probably be necessary.
Using the ResMerge Atom
The ResMerge Atom offers limited options, so determining when to use the ResMerge Atom versus separate Resource Atoms or a File Atom is important. The main purpose of the ResMerge Atom is to provide a simple high-level resource copy mechanism without forcing the scriptwriter to create numerous Resource Atoms.
The Installer executes a ResMerge Atom by automatically converting the atom into individual Resource Atoms when the Installer is ready to begin reading from the source disk. The Resource Atom is created with the following flags:
n dontDeleteWhenRemoving — The ResMerge Atom does nothing during a removal.
n dontDeleteWhenInstalling.
n copy.
n noTgtRequired — The target file will be created if it does not already exist.
n updateExisting — Existing resources with the same type and ID will be replaced.
n copyIfNewOrUpdate.
n srcNeedNotExist — Doesn’t really matter because if it didn’t exist we would not be creating this Resource Atom to copy it.
n byID.
n nameNeedNotMatch — The name is ignored, but the new name will replace the old name if different.
NOTE
System Software scriptwriters must use care when using the ResMerge Atom because on pre-7.0 systems we determine if the Folder Manager will be available based on the presence of a Resource Atom copying a ‘fld#’ resource. This means a separate Resource Atom must always be created to install the ‘fld#’ resource. u
ResMerge Atom Reference
The format of the ResMerge Atom is simple. Its template is shown below.
#define resMergeAtomFlags \
fill bit[16];
type 'inrm' {
switch {
case format0:
key integer = 0; /* ResMerge Atom Format version */
mergeAtomFlags; /* ResMerge Atom Flags */
unsigned longInt; /* Total Resources Size */
fileSpecID; /* Target File Spec. Rsrc ID */
fileSpecID; /* Source File Spec. Rsrc ID */
evenPaddedString; /* Status Description */
};
};
Field descriptions
ResMerge Atom Flags Currently reserved for use by Apple Computer, Inc. (2-bytes)
Total Resources Size The size that all resources will occupy in the target file. For most purposes, the size of the source file’s resource fork is an adequate estimate. This field is used by the Installer to figure the amount of disk space required. (4-bytes)
Target File Spec. Rsrc ID
The resource ID of a Target File Spec (‘intf’) script resource describing the desired location of the target file. (2-bytes)
Source File Spec. Rsrc ID
The resource ID of a Source File Spec (‘infs’) script resource describing the location of the source file. (2-bytes)
Status Description An optional string that is displayed in the Status dialog during execution of the ResMerge Atom. (even-padded Pascal string)
About the Folder Atom (‘infm’)
The Folder Atom can be used to copy all files from the root-level of a source folder to the root-level of a target folder. Each file is copied separately, replacing an existing file of the same name. Folders within the source folder are ignored, and must be copied using separate Folder Atoms. Because the Folder Atom offers no options, you may find that you will need to use individual Resource Atoms to copy some or all the resources.
The Folder Atom is unique from using File Atoms because anyone can add to or delete files from the source folder without changing the atom. This is OK as long as the Installer can successfully preflight the required disk space. A field in the atom holds the total size the source files. This flexibility comes at a cost to ease of use because the Installer cannot determine during preflighting how many files will be replaced, thus not requiring additional disk space. We will therefore usually overestimate the required disk space, forcing the user to make more space available than will probably be necessary.
NOTE
The Folder Atom only copies the files at the root level of the source folder. Nested folders must be copied separately with additional Folder Atoms. u
Using the Folder Atom
The Folder Atom offers no options, so determining when to use the Folder Atom versus separate File Atoms is important. The main purpose of the Folder Atom is to provide a simple high-level file copy mechanism without forcing the scriptwriter to create numerous File Atoms. The Folder Atom does not support decompression or version comparison.
The Installer executes a Folder Atom by automatically converting the atom into individual File Atoms when the Installer is ready to begin reading from the source folder. The File Atom is created with the following flags:
n dontDeleteWhenRemoving — The Folder Atom does nothing during a removal.
n dontDeleteWhenInstalling.
n copy.
n dontIgnoreLockedFile — The user is notified about locked target files, and the installation is stopped.
n dontSetFileLocked or setFileLocked — If the source file is locked it will be locked after it is copied.
n useSrcCrDateToCompare — Since no version compare procedure can be specified.
n srcNeedNotExist — Doesn’t really matter because if it didn’t exist we would not be creating this File Atom to copy it.
n rsrcForkInRsrcFork — Since no decompression is allowed.
n updateExisting — Existing files with the same name will be replaced.
n copyIfNewOrUpdate.
n rsrcFork — Copy resource fork if it exists.
n dataFork — Copy data fork if it exists.
Specifying the Source and Target Folder
The standard ‘infs’ and ‘intf’ file spec resources are used to specify the source and target folder with several differences:
n The path name is similar to normal file specs, but the path should end with the name of the source or target folder. A colon at the end of the path is optional.
n All File Spec flags are ignored when used with Folder Atoms.
n The File Type, File Creator and Creation Date fields are ignored when used with Folder Atoms.
NOTE
The reserved folder path name “special-xxxx” cannot be used with Folder Atoms. If you do, the user will be told the script document is damaged. u
Installing Folders with Custom Icons
The Folder Atom will automatically set the target folder to use the source folder’s custom icon if one exits. Although the scriptwriter need not be aware of how the custom icon is stored, the Installer uses the File Atom’s feature of setting the target folder’s icon whenever the special invisible “Icon\n” file is written to disk.
Creating Empty Folders with a Folder Atom
The Installer will not create a target folder if there are no files are present in the source file. If you wish to create an empty folder, the easiest work around is to create a custom icon for the source folder, thereby causing the invisible “Icon\n” file to be copied, and the target folder to be created.
Folder Atom Reference
The format of the Folder Atom is simple. Its template is shown below.
#define folderAtomFlags \
fill bit[16];
type 'infm' {
switch {
case format0:
key integer = 0; /* Folder Atom Format version */
folderAtomFlags; /* Folder Atom Flags */
unsigned longInt; /* Total Folder Size */
rsrcID; /* Target File Spec. Rsrc ID */
rsrcID; /* Source File Spec. Rsrc ID */
evenPaddedString; /* Status Description */
};
};
Field Descriptions
Folder Atom Flags Currently reserved for use by Apple Computer, Inc. (2-bytes)
Total Folder Size The size of all files in the source folder. This field is used by the Installer to figure the amount of disk space required. (4-bytes)
Target File Spec. Rsrc ID
The resource ID of a Target File Spec (‘intf’) script resource describing the desired location of the target folder. (2-bytes)
Source File Spec. Rsrc ID
The resource ID of a Source File Spec (‘infs’) script resource describing the location of the source folder. (2-bytes)
Status Description An optional string that is displayed in the Status dialog during execution of the Folder Atom. (even-padded Pascal string)
Using Action Atoms (‘inaa’)
Action Atoms are used to run a code resource at the beginning and/or end of an installation or removal.
To use an Action Atom, an 'inaa' resource must first be added to the script. This atom specifies the resource which contains an executable piece of code. The user-defined Action Atom code can be executed at two different times for installations. One is after the user clicks on the Install button but before installation begins. The other is after the installation is finished, but before the user is asked to quit or continue. The code can also be executed at two different times for removals. One is after the user clicks on the Remove button but before removal begins. The other is after the removal is finished, but before the user is asked to quit or continue. A new option allows the Busy Cursor animation to be continued/suspended during execution of the action atom code resource. This option is useful when the code resource displays a dialog and the Busy Cursor is not appropriate. For installation and removal the order of execution is defined by the ID of the 'inaa' resources.
Action Atom Reference
This section describes the Action Atom resource format, data structures and function interface.
Resource Description
The format of the Action Atom is shown below.
#define actionAtomFlagsFormat2 \ fill bit[12]; \
boolean continueBusyCursors, suspendBusyCursors \
boolean actAfter, actBefore; \
boolean dontActOnRemove, actOnRemove; \
boolean dontActOnInstall, actOnInstall;
type 'inaa' {
switch {
case format2:
key integer = 2; /* Action Atom Format version. */
actionAtomFlagsFormat2; /* Action Atom Flags */
literal longint; /* Code Resource Type */
integer; /* Code Resource ID */
longint; /* RefCon */
longint; /* Requested Memory (in bytes) */
evenPaddedString; /* Status Description */
};
};
Flag Descriptions
continueBusyCursors/suspendBusyCursors
Controls whether the counting fingers busy cursor should be stopped and an arrow cursor shown prior to calling the Action Atom code resource. Use the suspendBusyCursors flag when you want to display a dialog from within your Action Atom code resource.
actAfter/ActBefore Determines whether this Action Atom code resource is called before or after the installation/removal.
dontActOnRemove/actOnRemove
Determines if this Action Atom code resource should be called on a removal.
dontActOnInstall/actOnInstall
Determines if this Action Atom code resource should be called on an installation.
Field descriptions
Code Resource Type The resource type of the code resource, usually ‘infn’. (4-bytes)
Code Resource ID The resource ID of the code resource. (2-bytes)
RefCon A value to be passed directly to the code resource. For example, the System 7.X Installer script has all of its Action Atoms linked together into one code resource and uses this refCon value as a selector that tells which action atom to run. By linking all action atoms together into one code resource and eliminating duplicate code, we cut the size of our action atoms in half. (4-bytes)
Requested Memory The requested number of bytes that should be available in the Action Atom’s sub-heap when called. Enter 0 (zero) to not create a sub-heap and run inside the Installer’s heap. Please see warnings about using sub-heaps in the Atom Extender section if you specify a value other than 0. (4-bytes)
Status Description An optional string that is displayed in the Status dialog during execution of the Action Atom. (even-padded Pascal string)
Data Structures
Function Interface
The entry point of the Action Atom code resource must have the interface:
The Action Atom should return a result telling the Installer what to do after executing the code resource. You can use these constants to specify the result code:
enum { kActionAtomResultFatalError = -1,
kActionAtomResultContinue = 0,
kActionAtomResultCancel = 1 };
typedef long ActionAtomResult;
Return results produce the following effect:
n Return kActionAtomResultContinue if you wish the installation to continue.
n Return kActionAtomResultCancel to cancel the installation, just as if the user had pressed the Cancel button. When an action atom returns the cancel message, all action atom waiting in the queue are not run. Cancel messages are then sent to all ‘after’ action atoms to allow them to clean up their environment.
n Return kActionAtomResultFatalError to signal that there is something seriously wrong, and the installation should not continue. When an action atom returns the error message, all action atoms waiting in the queue are not run. Cancel messages are then sent to all ‘after’ action atoms to allow them to clean up their environment.
s W A R N I N G
If you choose to create a sub-heap for each invocation of format 2 of the Action Atom please read the section “Running with a Sub-Heap” within the Atom Extender portion of this document. You can enter 0 (zero) in the requested memory field to not create a sub-heap and run inside the Installer’s heap. s
Parameter Block
The Action Atom parameter block contains information about the Installer’s environment. The parameter block has the structure:
typedef struct {
InstallationStage fMessageID;
Handle fStaticDataHdl;
ProcPtr fCallBackProcPtr;
short fTargetVRefNum;
long fTargetFolderDirID;
short fSystemVRefNum;
long fSystemBlessedDirID;
long fRefCon;
Boolean fDoingInstall;
Boolean fDidLiveUpdate;
long fInstallerTempDirID;
}ActionAtom2PBRec, *ActionAtom2PBPtr;
Field Descriptions
fMessageID One of three messages the Atom Extender will receive when being called. Use these constants to understand the message ID:
enum {before,
after,
cleanUpCancel };
typedef unsigned char InstallationStage;
If your Action Atom is running before the installation takes place, the fMessageID field is before.
If your Action Atom is running after the installation completes successfully, the fMessageID field will be after.
If the user clicks the Cancel/Stop button, or the Installer cancels the installation because of an error, cleanUpCancel messages are sent to all ‘after’ action atoms to allow them to clean up their environment. Each ‘after’ action atom is guaranteed to receive only one cancel message if the installation is canceled or stopped. This may happen before the ‘before’ actions atoms have run, so it’s important to be smart within your cleanup routines.
fStaticDataHdl A handle created by the Action Atom using INewHandle to save information between before and after calls to this Action Atom. The field is always NULL when receiving a before message. You can assign a value to this field during the first call to the Action Atom, and receive the same value in this field during the next call.
fCallBackProcPtr A pointer to the Installer’s dispatch routine. You’ll need to pass this field as a parameter to glue routines that provide access to Installer functions.
fTargetVRefNum The target disk’s vRefNum. When allowing the user to select a target application folder, this is the volume on which the folder resides.
fTargetFolderDirID The target application folder’s directory ID. Target File Specs that use the reserved folder path folder-user will be placed in this folder. This value is -1 if the Installer is using disk mode, the folder does not exist, or a File Spec referencing the reserved folder path folder-user has not been referenced by any atom included in the installation.
fSystemVRefNum The system disk’s vRefNum. Target File Specs that use the reserved folder path special-xxx will be placed in the System Folder on this volume.
fSystemFolderDirID The directory ID of the System Folder on the disk with the refNum fSystemVRefNum. This directory is not necessarily the currently active System Folder.
fRefCon A 4-byte value defined by the scriptwriter in the ‘inex’ script resource.
fDoingInstall TRUE if the user is performing an installation; otherwise, FALSE if the user is removing.
fDidLiveUpdate TRUE if the Installer is modifying files inside the active System Folder.
fInstallerTempDirID The directory ID of the temporary folder on the volume specified in the fSystemVRefNum field. The temporary folder holds the files that we are modifying to allow rollback in case the installation is canceled. You’ll rarely ever need to look inside this folder.
Using Audit Atoms (‘inat’)
During the development of System Software scripts, there were many times we wished that there was a history of what had previously been installed. For example, the user did a minimal SE System Software installation, and later wanted to add minimal Macintosh II System Software. During the second installation, the Installer should be smart enough to update the disk with both SE and II software. Installer Audit Atoms were added to facilitate this type of updating. Their format is shown below.
When the Installer finds an Audit Atom in a script, after an installation is complete, it adds a new resource (type 'audt') to the target file specified in the Audit Atom. This resource contains an array of audit selector/value pairs. If an 'audt' resource already exists in the target file and there is no entry for the given selector, an entry is added. If an entry for the selector already exists, the higher of the two values is used. Using the Installer Rules checkAuditRecord and checkAnyAuditRecord, later installations can make decisions based on this history.
Audit Atom Reference
Resource Description
Format 0 of the ‘inat’ resource:
type 'inat' {
switch {
case format0:
key integer = 0;
FileSpecID; /* Target File Spec Rsrc ID*/
OSType; /* Audit Selector */
literal longint; /* Audit Value */
};
};
Field descriptions
Target File Spec. Rsrc ID
The resource ID of a Target File Spec. of which you want to add or update the audit resource. Apple uses the System File to keep a history of System Software that has been installed. A File Spec ('intf' resource) must exist in the script with this ID. (2-bytes)
Audit Selector A meaningful type. (4-bytes)
Audit Value A meaningful value. (4-bytes)
Using Boot Block Atoms (‘inbb’)
Boot Block Atoms are used to write or change the parameters in a target volume’s boot blocks. Boot Block Atoms are different from file and resource atoms – they can indicate something to be copied, or indicate an individual parameter that needs to be changed.
To cause boot blocks to be written to a target volume, include a Boot Block Atom with a key of type 'bbUpdate'. The argument to this type of Boot Block Atom is an integer which indicates the ID of a File Spec in the script. The file indicated by this File Spec should contain a 'boot' resource. A copy of the resource is written to the first two blocks of the target volume.
Boot Block Atom Reference
Resource Description
Format 0 of the ‘inbb’ resource:
#define BootBlockAtomFlags \
fill bit[14]; \
boolean dontChangeOnInstall, changeOnInstall; \
boolean dontChangeOnRemove, changeOnRemove;
#define BootBlockUpdateFlags \
fill bit[7]; \
boolean replaceBBSysName, saveBBSysName; \
boolean replaceBBShellName, saveBBShellName \
boolean replaceBBDbg1Name, saveBBDbg1Name; \
boolean replaceBBDbg2Name, saveBBDbg2Name; \
boolean replaceBBScreenName, saveBBScreenName; \
boolean replaceBBHelloName, saveBBHelloName; \
boolean replaceBBScrapName, saveBBScrapName; \
boolean replaceBBCntFCBs, maxBBCntFCBs; \
boolean replacebbCntEvts, maxBBCntEvts \
type 'inbb' {
switch {
case format0:
key integer = 0;
BootBlockAtomFlags;
switch {
case bbUpdate:
key integer = -1;
RsrcID;
BootBlockUpdateFlags;
case bbID:
key integer = 1;
decimal integer;
case bbEntry:
key integer = 2;
decimal longint;
case bbVersion:
key integer = 3;
decimal integer;
case bbPageFlags:
key integer = 4;
decimal integer;
case bbSysName:
key integer = 5;
EvenPaddedString;
case bbShellName:
key integer = 6;
EvenPaddedString;
case bbDbg1Name:
key integer = 7;
EvenPaddedString;
case bbDbg2Name:
key integer = 8;
EvenPaddedString;
case bbScreenName:
key integer = 9;
EvenPaddedString;
case bbHelloName:
key integer = 10;
EvenPaddedString;
case bbScrapName:
key integer = 11;
EvenPaddedString;
case bbCntFCBs:
key integer = 12;
decimal integer;
case bbCntEvts:
key integer = 13;
decimal integer;
case bb128KSHeap:
key integer = 14;
decimal longint;
case bb256KSHeap:
key integer = 15;
decimal longint;
case bb512KSHeap:
key integer = 16;
decimal longint;
case bbSysHeapSize:
key integer = 16;
decimal longint;
case bbSysHeapExtra:
key integer = 18;
decimal longint;
case bbSysHeapFract:
key integer = 19;
decimal longint;
};
EvenPaddedString; /* Boot Block Atom Description */
};
};
Flags descriptions
dontChangeOnInstall/changeOnInstall
Determine if the boot blocks should be updated during an installation. (2-bytes)
dontChangeOnRemove/changeOnRemove
Not currently supported. (2-bytes)
Field descriptions
Boot Block Value Key Specifies which boot block parameter is being given a value in the Boot Block Value field. The key can correspond to any of the parameters which are changeable in the boot blocks. (2-bytes)
The possible keys for this field are as follows:
bbUpdate Copy over boot blocks from a 'boot' resource found in the file whose File Spec ID is given in the 2-byte value field. A second 2-byte value field is used for this type of Boot Block Value. This second value field is used to specify which boot block fields are to be updated from the 'boot' resource, and which ones are to be preserved on the target disk. If bits 0 through 6 are set, the appropriate value on the target is kept if it appears to be a legal value or string. If bits 7 or 8 are set, the maximum parameter from the resource or what already exists on the target is preserved. The format of this field is as follows:
bbID The Boot Block Value field updates the boot blocks ID (2-bytes).
bbEntry The value updates the boot block entry point (4-bytes).
bbVersion The value updates the boot block version (2-bytes).
bbPageFlags The value updates the page 2 usage flags (2-bytes).
bbSysName The value updates the name of the system resource file (string).
bbShellName The value updates the name of the system shell (string).
bbDbg1Name The value updates the first loaded debugger’s name (string).
bbDbg2Name The value updates the second loaded debugger’s name (string).
bbScreenName The value updates the file name of the startup screen (string).
bbHelloName The value updates the file name of the startup program (string).
bbScrapName The value updates the file name of the system scrap file (string).
bbCntFCBs The value updates the number of FCBs to open (2-bytes).
bbCntEvts The value updates the size of the event queue (2-bytes).
bb128KSHeap This boot block field is no longer used.
bb256KSHeap This boot block field is no longer used.
bb512KSHeap The value updates the size of the system heap on a 512K Mac (4-bytes).
bbSysHeapSize The value updates the absolute size of the system heap (4-bytes).
bbSysHeapExtra This boot block field is no longer used.
bbSysHeapFract The value updates the minimal additional system heap space required (4-bytes).
Note: Under System 7.0 and greater, the system heap space and the number of FCBs to open are dynamically determined and not controlled by the boot block value.
Boot Block Value The value for the boot block parameter that was specified in the boot block value key. It has a size as given above (in parentheses). (size depends on the type of update)
About Atom Extenders (‘inex’)
Scriptwriters can use Atom Extenders to enhance or replace the default copy mechanism of the Installer. The most obvious purpose of the Atom Extender is to provide transparent decompression of files during installation. Scriptwriters presently using Action Atoms to perform decompression, either written by themselves or a third-party developer, will want to use Atom Extenders for this purpose in the future.
If you want to write an Atom Extender then read the section “Writing Atom Extenders” to learn how. If you only want to take advantage of an Atom Extender someone else has written then consult the sections describing the File Atom, Resource Atom and Font Atom.
Writing Atom Extenders
An Atom Extender is a newly-defined script resource of type ‘inex’ that can be referenced from new versions of the File Atom, Resource Atom, and Font Atoms. At the heart of the Atom Extender is a code resource (provided by the scriptwriter) that contains the necessary 68K code to be executed at the desired point in the installation.
This section describes the necessary steps to create an Atom Extender.
Creating an ‘inex’ Script Resource
The new ‘inex’ script resource contains the necessary information to properly call the specified code resource.
continueBusyCursors, /* Show busy cursor during call */
'infn', /* Resource type of code resource */
128, /* Resource ID of code resource */
100, /* RefCon (long integer) */
30720, /* 30K of requested free memory in heap */
"This is a test." /* Status description during call */
}
};
The sample ‘inex’ resource in Code Listing 3-1 asks the Installer to call the code resource with the type ‘infn’ and ID = 128 before the Installer begins copying the atom’s data from which the Atom Extender is referenced. When the code resource is called it will have a maximum of 30720 bytes of free memory in its own heap, from which it can allocate memory using Memory Manager routines, such as NewPtr and NewHandle. You must check the actual size of the heap at the beginning of your code resource to make sure you were allocated the full amount, since the Installer calls you whether or not your requested was fully granted. This error will usually be an idication that the Installer’s memory partition is set too low. The actual heap size is usually 5K larger than the requested size, but you should never depend on this being true.
NOTE
Atom Extenders are only called during installations, never during removals. u
Writing a Simple Atom Extender
A very simple task for an Atom Extender is to simulate the default copy task of the Installer using the supplied Installer routines. In Code Listing 3-2 the function reads and writes the atom’s data using the Installer routines ReadSourceData and WriteTargetData.
Code Listing 3-2 Simple Atom Extender performing a direct copy of an atom’s data.
// -- Read as much as we can up to the size of the buffer.
theErr = ReadSourceData( &dataLen, theBufferPtr);
// -- Loop while there is more data to read.
while( dataLen > 0 ) {
// -- This is where we can massage the data before writing it out.
// For example, if the source files were compressed, this is
// where we might call our decompression routine.
// -- Write the data out.
theErr = WriteTargetData( dataLen, theBufferPtr);
// -- Read as much as we can up to the size of the buffer.
if( theErr == noErr ) {
theErr = ReadSourceData( &dataLen, theBufferPtr);
// -- If we got eofErr, then we know we're done,
// and dataLen will be 0 (zero).
if( theErr == eofErr )
theErr = noErr;
}
} // while not done copying
if( theErr == noErr )
resultCode = kCopiedData;
else
resultCode = kFatalError;
// -- Dispose the buffer
DisposPtr(theBufferPtr);
}
else
resultCode = kFatalError;
break;
// -- For this example, we ignore the other messages.
case kInitialize:
case kAfterPart:
case kSuccess:
case kCancel:
resultCode = kContinueAsNormal;
break;
}
return resultCode;
}
Once the code in Code Listing 3-2 has been compiled into a code resource, it can be called from any atom and will copy the atom’s data as if the Installer had performed the copy. This also works for atoms whose source pieces have been split across multiple source disks, because the Installer keeps track of where each source piece should be written in the target file. The Installer data routines are similar to high-level File Manager routines:
n ReadSourceData — Similar to FSRead.
n WriteTargetData — Similar to FSWrite.
n SetTargetDataPos and SetSourceDataPos — Similar to SetFPos.
n GetTargetDataPos and GetSourceDataPos — Similar to GetFPos.
n GetTargetDataEOF and GetSourceDataEOF — Similar to GetEOF.
One of five messages can be sent to the Atom Extender. Flags in the ‘inex’ resource specify which messages the Atom Extender wishes to receive. The Atom Extender writer can examine the fMessageID field in the parameter block to determine which message has been sent. The following messages have been defined:
n kInitialize — Sent after the user clicks the Install button and preflighting has successfully completed.
n kBeforePart — Sent after the Installer has opened the atom’s source file and is about to copy the atom’s data.
n kAfterPart — Sent after the atom’s data has been successfully copied.
n kSuccess — Sent after the entire installation has successfully completed.
n kCancel — Sent after an installation was stopped due to an error or cancelation by the user, Action Atom or Atom Extender.
The Atom Extender must return a result telling the Installer what to do after receiving each message. The result codes, kFatalError, kContinueAsNormal, kCancelInstallation can be returned for any message. If you do not want to change the default action of the Installer, return kContinueAsNormal; otherwise, return kFatalError or kCancelInstallation to stop the installation. If the message was kBeforePart and you’ve copied the data yourself (with or without the supplied Installer routines) then return kCopiedData.
Memory Allocation within Atom Extenders
When the Atom Extender is executed, memory allocated using Macintosh OS/Toolbox routines will come from a sub-heap created by the Installer. The size of the sub-heap is determined by the requested free memory field of the ‘inex’ resource, and the available room in the Installer’s heap. You must check the actual size of the heap to make sure you were allocated all of the memory you requested, since the Installer calls you whether or not all your request was allocated. This helps the Installer maintain better control over all memory allocation.
The scriptwriter may need to adjust the size of the Installer’s partition to make sure enough memory is always available for the Atom Extender’s needs. The following equation helps determine the Installer’s partition size for the required free memory and other factors.
runTimeSize = size of the largest: ‘FOND’ resource, Desk Accessory resource, or owned resource being copied.
extenderSize = largest required free memory of any Atom Extender + code size of all Atom Extenders, in use during an installation + the total amount of static memory allocated.
Installer 4.0 provides memory management routines of its own to allow Atom Extenders to use available memory from the MultiFinder and Installer heaps. These routines are very similar to the Memory Manager calls, but are needed to maintain compatibility with pre-7.0 MultiFinder temporary memory calls.
n INewHandle — Similar to NewHandle, but always use IDisposHandle to dispose this handle, and IHLock and IHUnlock to lock and unlock this handle. The handle may or may not have been allocated in the MultiFinder heap.
n IDisposHandle — Similar to DisposHandle.
n IHLock — Similar to HLock.
n IHUnlock — Similar to HUnlock.
The INewHandle routine has been provided for two main purposes. The first purpose is to allow access to extra memory, when available, to make the actions of an Atom Extender more efficient. The second purpose is to allow memory to be maintained over invocations of an Atom Extender.
Running within a Sub-Heap
A sub-heap for memory allocation is mandatory for Atom Extenders to prevent gridlock when buffering data. Sub-heaps are optional for the other code resources that can be called during an installation, such as search procedures, Action Atoms and rule functions. We suggest some do’s and don’ts on dealing with sub-heaps below.
DO’s:
n Sub-heaps are mandatory for Atom Extenders, but other code resources can run inside the Installer’s heap, so enter 0 (size) as the request memory size if you don’t want to bother with sub-heaps.
n Set the current zone to the application heap before calling any Toolbox routine, and restore it afterwards. This assures that memory allocated within these calls won’t get left in your sub-heap.
n Use the Installer’s memory routines, unless you want the memory allocated directly from your sub-heap.
DON’Ts:
n Watch out for memory that is left in the sub-heap after you return control to the Installer that the system may have references to. If you set the current zone to the application heap before calling any Toolbox routine you shouldn’t have any problems. For example, if you call the GetResource routine (without properly setting the zone) that allocates a handle inside your sub-heap the Installer may crash after returning control to the Installer
n Never return a reference to a handle allocated in your sub-heap for the fStaticDataHdl field. Since the sub-heap is destroyed between invocations of the code resource, it’s best to use INewHandle to allocate any handle you store in the fStaticDataHdl field.
n Never assume you received a sub-heap of the full size requested. Check that you have enough memory enough to complete your task, since the Installer calls you whether or not your full request was allocated. Look for warning messages in the Installer Debugger to help identify this situation.
Converting Existing Decompression Code
Conversion is simple for those decompressors that access files using standard File Manager calls. The Installer routines have been designed to easily replace calls to the high-level File Manager routines: FSRead, FSWrite, SetFPos, GetFPos and GetEOF.
If your decompression code must use a temporary file to store partially decompressed data, then it’s up to you to create and destroy this file. Space on the target disk can be reserved by adding the needed space to one File Atom installed to the target disk. As an alternative, the Installer INewHandle routine can be used to allocate a temporary buffer if sufficient memory exists, but the availability of this memory is never guaranteed.
If your original decompression code comes from an application and you are using the MPW development system, make sure to read Tech. Note #256. To access global data you will need to create your own A5 world and switch back to the Installer’s A5 world before calling any Installer routine or Mac Toolbox trap. Avoiding global data makes writing code resources easier unless your development system (i.e. THINK C) supports using the A4 register to access global data.
Atom Extender Reference
This section describes the data structures and routines that are used by Atom Extenders. You’ll need to include the interface file “AtomExtenderHeader.h” or “AtomExtenderHeader.p” to have access to these data structures and routines.
Resource Description
Information about how to call the Atom Extender code resource is contained in the script resource of type ‘inex’. New versions of File Atoms, Resource Atoms and Font Atoms reference the ‘inex’ resource using its resource ID. The resource has the template:
sendInitMessage Asks to send an kInitialize message to those Atom Extenders attached to atoms that will be executed during the installation. The Atom Extender receives the kInitialize message after each time the user clicks the Install button and preflighting is successful. The purpose of the kInitialize message is to allocate any static memory needed to communicate between Atom Extenders.
sendBeforeMessage Asks to send a kBeforePart message to the Atom Extender code resource when the atom part is ready to be copied. The Installer has found and opened the source file that the part exists in and is ready to begin buffering the source data. The Atom Extender can override the Installer’s default copy mechanism by using the supplied routines and returning a kCopiedData result code.
sendAfterMessage Asks to send an kAfterPart message to the Atom Extender code resource for each part that has been successfully written by the Installer or Atom Extender. An kAfterPart message is only sent if the Installer performed the copy or the Atom Extender called WriteTargetData (with data length greater than 0) during a kBeforePart message.
sendSuccessMessage Asks to send a kSuccess message to the Atom Extender code resource after the entire installation has successfully completed. The purpose of the kSuccess message is to allow disposal of any static memory allocated during the kInitialize message, and delete any temporary files that were created by the Extender. Only those Atom Extenders that received kInitialize messages will be sent a kSuccess message.
sendCancelMessage Asks to send a kCancel message to the Atom Extender code resource when the user cancels the installation, an error forces the installation to stop, or an Atom Extender cancels the installation. The purpose of the kCancel message is to reverse any changes that were made during the installation, and dispose of any static memory allocated during the kInitialize message. Only those Atom Extenders that received kInitialize messages will be sent a kCancel message.
Field descriptions
Code Resource Type The resource type of the Atom Extender code resource to be called. (4-bytes)
Code Resource ID The resource ID of the Atom Extender code resource to be called. (2-bytes)
RefCon Value The value that will be passed in the fRefCon field of the Atom Extender parameter block. (4-bytes)
Required Free Memory The minimum number of free bytes the Atom Extender needs in its own heap to make local allocation of memory using Macintosh OS/Toolbox routines. (4-bytes)
Status Description An optional string that is displayed in the Status dialog during execution of the Atom Extender. (even-padded Pascal string)
Data Structures
Function Interface
The entry point of the Atom Extender code resource must have the interface:
The Atom Extender should return a result telling the Installer what to do after executing the code resource. You can use these constants to specify the result code:
typedef enum {
kFatalError = -1, /* Stop installation with error user dialog. */
kContinueAsNormal = 0, /* Request default action from Installer. */
kCancelInstallation = 1, /* Cancel installation with cancel user dialog. */
The AtomExtender parameter block contains information about the atom being installed. Most Atom Extenders will only need to reference a few fields from this parameter block. The parameter block has the structure:
typedef struct {
ExtenderMessageID fMessageID;
Handle fStaticDataHdl;
ProcPtr fCallBackProcPtr;
short fTargetVRefNum;
long fTargetFolderDirID;
short fSystemVRefNum;
long fSystemBlessedDirID;
long fRefCon;
DataType fDataType;
} EnvironsHeaderRec;
typedef struct {
FSSpec fSourceFile;
FSSpec fTargetFile;
long fTotalTargetSize;
long fTargetPosStart;
long fTargetPartSize;
long fSourcePartSize;
long fInstallerTempDirID;
} CopyHeaderRec;
typedef struct {
EnvironsHeaderRec fEnvironmentHeader;
CopyHeaderRec fCopyPBHeader;
} BasicCopyRec;
typedef struct {
EnvironsHeaderRec fEnvironmentHeader;
CopyHeaderRec fCopyPBHeader;
ResType fSourceRsrcType;
short fSourceRsrcID;
ResType fTargetRsrcType;
short fTargetRsrcID;
Str255 fTargetRsrcName;
short fTargetRsrcAttrs;
} RsrcCopyRec;
typedef struct {
EnvironsHeaderRec fEnvironmentHeader;
TCopyHeaderRec fCopyPBHeader;
ResType fSourceFontRsrcType; /* usually ‘part’ */
short fSourceFontRsrcID;
ResType fTargetFontRsrcType; /* FONT, NFNT, or sfnt */
short fTargetFontRsrcID;
Str255 fTargetFontRsrcName;
short fTargetFontRsrcAttrs;
Str255 fFamilyName;
short fFamilyID;
short fFontSize;
short fFontStyle;
} FontCopyRec;
typedef union {
BasicCopyRec fBasicPBRec;
BasicCopyRec fFileCopyPBRec;
RsrcCopyRec fRsrcCopyPBRec;
FontCopyRec fFontCopyPBRec;
} ExtenderPBRec, *ExtenderPBPtr;
Field descriptions
fMessageID One of five messages the Atom Extender will receive when being called. Use these constants to understand the message ID:
typedef enum {
kInitialize = 0,
kBeforePart = 1,
kAfterPart = 2,
kSuccess = 3,
kCancel = 4
} ExtenderMessageID;
Certain fields in the Atom Extender parameter block may or may not be valid when receiving a specific message. Each of the following field descriptions include a note about when the field is valid.
fStaticDataHdl A handle created by the Atom Extender using INewHandle to save information between calls to this Atom Extender code resource. The field is always NULL when receiving an kInitialize message. You can assign a value to this field during any call to the Atom Extender, and receive the same value in this field during the next message. (Valid for all messages.)
fCallBackProcPtr A pointer to the Installer’s dispatcher routine. You’ll need to pass this field as a parameter to glue routines that provide access to Installer functions. (Valid for all messages.)
fTargetVRefNum The target disk’s vRefNum. When allowing the user to select a target application folder, this is the volume on which the folder resides. (Valid for all messages.)
fTargetFolderDirID The target application folder’s directory ID. This value is -1 if the user cannot select a target application folder. Target File Specs that use the reserved folder path folder-user will be placed in this folder. (Valid for all messages.)
fSystemVRefNum The System disk’s vRefNum. Target File Specs that use the reserved folder path special-xxx will be placed in the System Folder on this volume. (Valid for all messages.)
fSystemFolderDirID The directory ID of the System Folder on the disk with the refNum fSystemVRefNum. This directory is not necessarily the currently active System Folder. (Valid for all messages.)
fRefCon A 4-byte value defined by the scriptwriter in the ‘inex’ script resource. (Valid for all messages.)
fDataType One of five values that specifies the type of data the Atom Extender has been given. Use this value to determine which type of atom is being installed, and which variant of the parameter block should be used. Use these constants to understand the data type:
typedef enum {
kFileAtomDataFork = 0,
kFileAtomRsrcFork = 1,
kFileAtomRsrcForkInDataFork = 2,
kRsrcAtom = 3,
kFontAtom = 4
} DataType;
(Valid for all messages.)
fSourceFile An FSSpec record specifying the source file from which the source data is read. (Valid only for kBeforePart and kAfterPart messages.)
fTargetFile An FSSpec record specifying the target file to which the target data is written. (Valid only for kBeforePart and kAfterPart messages.)
fTotalTargetSize The number of bytes all source pieces will occupy in the target. (Valid only for kBeforePart and kAfterPart messages.)
fTargetPosStart The offset in bytes into the target data the part’s data is written. (Valid only for the kBeforePart and kAfterPart messages.)
fTargetPartSize The size in bytes the part’s data will occupy in the target. (Valid only for the kBeforePart and kAfterPart messages.)
fSourcePartSize The size in bytes the part’s data occupies in the source. (Valid only for the kBeforePart message.)
fInstallerTempDirID The directory ID of the Installer temp folder on the target’s volume that contains the original target file. If this field is -1, the original file was not saved or did not exist. You can get the target’s volume refNum from the fTargetFile field. (Valid only for the kBeforePart and kAfterPart messages.)
Field descriptions for Resource Atoms
fSourceRsrcType The resource type of the source resource part. (Valid only for kBeforePart and kAfterPart messages.)
fSourceRsrcID The resource ID of the source resource part. (Valid only for kBeforePart and kAfterPart messages.)
fTargetRsrcType The resource type of the target resource. (Valid only for kBeforePart and kAfterPart messages.)
fTargetRsrcID The resource ID of the target resource. (Valid only for kBeforePart and kAfterPart messages.)
fTargetRsrcName The resource name to be given to the target resource. (Valid only for kBeforePart and kAfterPart messages.)
fTargetRsrcAttrs The resource attributes to be given to the target resource. (Valid only for kBeforePart and kAfterPart messages.)
Field descriptions for Font Atoms
fSourceFontRsrcType The resource type of the source font resource part. (Valid only for kBeforePart and kAfterPart messages.)
fSourceFontRsrcID The resource ID of the source font resource part. (Valid only for kBeforePart and kAfterPart messages.)
fTargetFontRsrcType The resource type of the target font resource. (Valid only for kBeforePart and kAfterPart messages.)
fTargetFontRsrcID The resource ID of the target font resource, which is not known until the part has been written by the Installer. (Valid only for the kAfterPart messages.)
fTargetFontRsrcName The resource name to be given to the target font resource. (Valid only for kBeforePart and kAfterPart messages.)
fTargetFontRsrcAttrs The resource attributes to be given to the target font resource. (Valid only for kBeforePart and kAfterPart messages.)
fFamilyName The family name (i.e. “Times”, “Geneva”… ). The source ‘FOND’ resource can be found using this name. (Valid only for kBeforePart and kAfterPart messages.)
fFamilyID The family ID. Normally this is the resource ID of the ‘FOND’ resource. (Valid only for kBeforePart and kAfterPart messages.)
About Version Compare Functions (‘invc’)
Version Compare functions allow external code resources to be called when the target file or resource’s version must be determined in order to compare with the source version number supplied in the script.
The Installer 3.X versions allow the scriptwriter to specify how it should handle the case where the target file is newer than the source file. This usually prevents downgrading the user’s software, but the opposite case may occur where downgrading is required to maintain sync-ed versions of software. Previously, the determination of “newness” was dependent on comparing the creation dates of the target file to the value in the source ‘infs’ resource. This works most of the time, but is not a reliable way to compare files.
All files being installed should have a version resource (‘vers’ 1 and maybe a ‘vers’ 2), and the ability to “newness” of files based on version resource is a desirable feature. Installer 4.0 now provides three ways to compare files:
n Old way using creation date. Use the useSrcCrDateToCompare flag in the File Atom.
n Default version number comparison using the ‘vers’ 1 resource in the target file. Use the useVersProcToCompare flag in the File Atom. Place the source version number in the Source Version Number field and place 0 (zero) in the Version Compare Rsrc ID field of the File Atom.
n Custom determination of the target version number of a file or resource using a code resource. Use the useVersProcToCompare flag in the File Atom. Place the source version number in the Source Version Number field and place the ‘invc’ resource ID in the Version Compare Rsrc ID field of the File Atom or Resource Atom.
Using Version Compare Functions with File Atoms
During preflighting of the target disk the Installer will call the Version Compare code resource for each existing target file that references a valid ‘invc’ script resource. Upon entering the code resource the current resource file will have been set to the target file, so the code resource can easily make Resource Manager calls to read an alternative version resource. If the version information is stored in the data fork, or in another file the code resource must open and close the file themselves.
The Compare Version code resource must return the version number as the function result. If an error occurs while finding the version number, then return 0 (zero).
Allowable Installer functions when comparing the version of a file:
n Memory functions: INewHandle, IDisposHandle, ILockHandle, IUnLockHandle.
n Action Handler function: RegisterAction.
Using Version Compare Functions with Resource Atoms
During preflighting of the target disk the Installer will call the Version Compare code resource for each existing target resource that references a valid ‘invc’ script resource. Upon entering the code resource the current resource file will have been set to the file the target resource resides. The code resource should call the Installer’s ReadTargetData routine to read from the target resource. This should allow most resource version schemes using a header to easily and quickly determine the version number of the resource. Using Resource Manager calls should be avoided.
The Compare Version code resource must return the version number as the function result. If an error occurs while finding the version number, then return 0 (zero).
Allowable Installer functions when comparing the version of a resource:
n Memory functions: INewHandle, IDisposHandle, ILockHandle, IUnLockHandle.
n Target functions: ReadTargeData, GetTargeDataEOF, GetTargeDataPos, SetTargeDataPos.
n Action Handler function: RegisterAction.
Version Compare Runtime Environment
The Version Compare code resource shares memory space with the Installer. Local memory allocation using Memory Manager calls will come from the Installer’s heap. Please be nice to our heap.
Version Compare Function Reference
This section describes the function interface and resource descriptions needed to use the Version Compare script resource.
Function Interface
The Installer calls your Version Compare code resource assuming the following function interface.
long ComputeVersionNumber( ComputeVersionPBPtr );
The Version Compare function writer must return a version number. The version number consists of four bytes defined from the high byte as: major revision level, minor revision level, development stage, and prerelease revision level. See Inside Macintosh: Macintosh Toolbox Essentials, page 7-31 for more details.
Parameter Block
The version compare code resource is passed a pointer to a parameter block containing the callback pointer.
typedef struct {
ProcPtr fCallBackProcPtr;
} ComputeVersionPB, *ComputeVersionPBPtr;
Field descriptions
fCallBackProcPtr A pointer to the Installer’s dispatch routine. You’ll need to pass this field as a parameter to Installer function glue routines.
Resource Description
The template of the Version Compare script resource is shown below.
#define versionCompareFlags \
fill bit[16];
type 'invc' {
switch {
case format0:
key integer = 0; /* Format version */
versionCompareFlags; /* Version Compare */
literal longint; /* Version Compare Code Rsrc Type */
integer; /* Version Compare Code Rsrc ID */
longint; /* Minimal Requested Memory */
evenPaddedString; /* Summary */
};
};
Field descriptions
Version Compare Flags Currently reserved for use by Apple Computer, Inc. (2-bytes)
Version Compare Code Rsrc Type
The resource type of the Version Compare code resource. (4-bytes)
Version Compare Code Rsrc ID
The resource ID of the Version Compare code resource. (2-bytes)
Minimal Required Memory The minimum number of free bytes the Version Compare code resource needs during execution. (4-bytes)
NOTE
Unless your Version Compare routine has a special need for it's own memory heap, you should always assign this field a value of zero. A value of zero allows the Version Compare routine to use the Installer’s allocated memory.u
Version Compare Summary An optional string briefly describing the purpose of this Version Compare function. This string is never displayed to the user. (even-padded Pascal string)
Installer Rules
This chapter describes how to use Frameworks, Rules and Rule Clauses to make intelligent installation recommendations to the user.
Frameworks (‘infr’)
Rules are evaluated when the Installer is launched; and, when needed, while the user is interacting with the interface.
Times when rules are evaluated:
n The rules are first evaluated immediately after the user dismisses the splash screen. If no splash screen is provided, then before showing the Easy Install or Custom Install dialog.
n The user selects a different target disk, application folder or system disk while in Easy Install or Custom Install.
n The user returns to the Installer from another application when running in a MultiFinder environment.
n The currently selected target disk changes because the user clicks the Eject Disk button, or inserts a disk, or the disk goes offline because of a network failure or system activity.
Global Rule Framework
The global framework provides common rules between the custom install and the easy install frameworks. The global framework will always be executed before the easy install or custom install frameworks. It allows smaller and simpler scripts by allowing the other frameworks to refer to assertions set in the global framework. All rule clauses can be called in the global framework, but those not relevant to the interface mode are ignored. The global framework is located by looking for an ‘infr’ resource of ID 765.
Easy Install Rule Framework
The Easy Install rule framework provides control over the message area in the Easy Install screen. When the Installer finds and opens the script, the Easy framework is located by looking for an ‘infr’ resource that does not have the ID of 765 or 766. This is to provide compatibility with Installer 3.4.X scripts that can use any ID for their ‘infr’ resource. It is recommended that the Easy framework resource have the ID of 764.
Custom Install Rule Framework
The Custom Install rule framework provides control over items shown in the Custom Install list. When the Installer finds and opens the script, a Custom framework is located by looking for an ‘infr’ resource of ID 766. If one is not found, the Installer uses the Installer 3.X method of determining which packages should be shown in the Custom Install list.
When a Custom Install framework is found in the script, the scriptwriter must call the new rule clause AddCustomItem for each top-level item to be displayed in the Custom Install list. The AddCustomItem rule clause accepts a list of the package (‘inpk’) IDs. The items will be listed in the order they are added. Sub-packages with the showsOnCustom flag set will automatically be added at the appropriate levels in the hierarchical Custom Install list.
Like the Easy Install framework, the Custom Install framework executes every time the user switches to Custom Install, changes the target disk/folder selection, or brings the Installer forward.
Rules (‘inrl’)
Rules, which are organized by the rule framework, provide the intelligence for making the Easy Install interface possible. Rules can examine the installation environment, save information about the installation environment to simplify other rules, provide information to the user about what the Easy Install will do for them, report errors, and/or determine which packages will be used in the Easy Install process.
Rules are composed of one or more clauses. Each clause returns a boolean value. The first clause that returns FALSE terminates the rule. If the terminated rule is part of a pickFirst set in the rule framework then the following rule, if any, is evaluated. If all of the clauses in a rule return TRUE, the rule is said to fire. If the firing rule is part of a pickFirst set in the rule framework then no more rules in the set are evaluated.
Clauses can be combined to develop the equivalent of an if-then statement. For example, the if-then statement:
IF the chosen target is a floppy disk
THEN use the package named floppyInstall in the Easy Install
would be written as a rule as follows:
resource 'inrl' (rFloppyInstall) {
format0 {{
checkTgtVolSize {floppy, floppy}, <-- A Clause
addPackages {{pFloppyInstall}} <-- Another Clause
}};
};
The scriptwriter defines the constants rFloppyInstall and pFloppyInstall earlier in the script (for example: #define rFloppyInstall 1000). This rule has two clauses. The first clause, checkTgtVolSize returns TRUE if the currently chosen target volume is a floppy. If checkTgtVolSize returns TRUE, the second clause is evaluated. This second clause, addPackages, always returns TRUE, but also has the effect of adding the package whose ID is pFloppyInstall to the list of packages to be used in the Easy Install. So, if the first clause is TRUE, the addPackages clause will be TRUE and the rule will fire.
Clauses can be ANDed together. For example, we could write:
IF the chosen target is a floppy disk
AND we are installing on a Mac+
THEN return the package named floppyInstall to Easy Install
AND add “• Mac+ Floppy Installation” to the Easy Install text
This rule has four clauses. If the first two return TRUE (i.e., we are installing onto a floppy and the current machine is a Mac Plus) then the second two clauses will be evaluated. Note that the clauses addPackages and addUserDescription always return TRUE.
For a more complete example, suppose you wanted to add a piece of text to the Easy Install message which described the machine you were installing onto. The pseudo code is as follows:
IF (Machine=Plus) THEN
Return the message 'Installing onto your Macintosh Plus'
ELSE IF (Machine=SE) THEN
Return the message 'Installing onto your Macintosh SE
ELSE IF (Machine=II) THEN
Return the message 'Installing onto your Macintosh II'
The rule framework is as follows:
resource 'infr' (kEasyInstallFrameworkRsrcID ) {
format0 {{
pickFirst, {rPlusUD, rSEUD, rIIUD},
}}
};
The rules which this framework references are as follows:
addUserDescription {'Installing onto your Macintosh II}
}};
};
The constants, rPlusUD, rSEUD, and rIIUD would be defined in the script before being used.
Using Assertions
It is often useful to keep track of information about the type of installation that is being done. This allows a more natural script organization. Note: The Installer clears all assertions prior to firing rules. Suppose, for example, that many of the rules in a script depended on knowing whether an update or a new install was being done. The pseudocode for this is as follows:
IF System File Exists
AND Installing on Mac+
THEN Use Mac+ Update packages
IF System File Exists
AND Installing on MacSE
THEN Use MacSE Update packages
More conveniently (and with better performance):
IF System File Exists
THEN Assert(updating)
IF updating
AND Installing on Mac+
THEN Use Mac+ Update packages
IF updating
AND Installing on MacSE
THEN Use MacSE Update packages
Assertions provide this functionality. Using assertions is a three-step process: 1) define a unique constant for the assertion, 2) set the assertion using an AddAssertion clause, and 3) check the assertions via CheckAllAssertions, CheckAnyAssertion, CheckMoreThanOneAssertion, CheckAllNonAssertions, or CheckAnyNonAssertion clauses. The above example is written as follows:
gestaltSelector A selector value specifying the type of system information to check. (4-bytes)
gestaltReturnValuesList A list of Gestalt return values. If the Gestalt result matches one of the values in the list the function will return TRUE. (4-bytes)
DESCRIPTION
Use the CheckGestalt clause to check a Gestalt attribute. CheckGestalt takes two arguments: a Gestalt selector, and a list of valid Gestalt return values. The Installer calls Gestalt with the given selector. If the Gestalt return value is in the list of valid return values, checkGestalt returns TRUE.
NOTE
If the Gestalt selector specified requires a value containing flags ( or a bit mask ), you should use the CheckGestaltAttributes routine described below. u
gestaltSelector A selector value specifying the type of system information to check. (4-bytes)
bitMask A bit mask that will be AND’ed with actual result from the Gestalt call. (4-bytes)
DESCRIPTION
Use the CheckGestaltAttributes clause to check one or more specific bits in the Gestalt value. Passing a bit mask with more than one bit set will effectively OR the specified bits in the Gestalt result value. CheckGestaltAttributes takes two arguments: a Gestalt selector, and a bit mask. The Installer calls Gestalt with gestaltSelector, then AND’s the result value with bitMask. If this value is non-zero then CheckGestaltAttributes returns TRUE.
CheckMinMemory
CheckMinMemory{ minimalMemory }
minimalMemory The minimal number of megabytes of physical memory. (4-bytes)
DESCRIPTION
Use CheckMinMemory to specify the minimal amount of physical memory needed for an installation. Note that you cannot use CheckGestalt for this job unless you want to list all of the memory configurations applicable for an installation. CheckMinMemory takes a single argument: the minimal amount of memory (in MB) needed for this clause to be TRUE.
CheckFileDataForkExists
CheckFileDataForkExists{ targetFileSpecRsrcID }
targetFileSpecRsrcID A Target File Spec resource ID. (2-bytes)
DESCRIPTION
Use CheckFileDataForkExists to determine whether a specific file has a data fork. It takes a single argument: the Target File Spec ID of the file you are interested in. CheckFileDataForkExists returns TRUE if the file referenced by the File Spec exists and has a data fork.
CheckFileRsrcForkExists
CheckFileRsrcForkExists{ targetFileSpecRsrcID }
targetFileSpecRsrcID A Target File Spec resource ID. (2-bytes)
DESCRIPTION
Use CheckFileRsrcForkExists to determine whether a specific file has a resource fork. It takes a single argument: the Target File Spec ID of the file you are interested in. It returns TRUE if the file referenced by the File Spec exists and has a resource fork. CheckFileRsrcForkExists is a convenient way to see if a file which contains code exists..
targetFileSpecRsrcID A Target File Spec resource ID. (2-bytes)
resourceType A resource type. (4-bytes)
resourceID A resource ID. (2-bytes)
DESCRIPTION
Many times it is necessary to determine whether a specific file contains a specific resource. Use the checkFileContainsRsrcByID clause to determine whether a file has a resource with a known type and ID. checkFileContainsRsrcByID takes three arguments: the File Spec ID of the target file, the type of the resource, and the ID of the resource.
targetFileSpecRsrcID A Target File Spec resource ID. (2-bytes)
resourceType A resource type. (4-bytes)
resourceName A resource name. (even-padded Pascal string)
DESCRIPTION
Use checkFileContainsRsrcByName to determine whether a file has a resource with a known type and name. checkFileContainsRsrcByName takes three arguments: the File Spec ID of the target file, the type of the resource, and the name of the resource.
targetFileSpecRsrcID A Target File Spec resource ID. (2-bytes)
majorVersNum The major version number. (2-bytes)
minorVersNum The minor version number. (2-bytes)
releaseStage The release stage. Four release stage constants are defined in the InstallerTypes.r file: development, alpha, beta, final and release. (2-bytes)
releaseNum The release number. (2-bytes)
DESCRIPTION
Use CheckFileVersion to check the version of a file. CheckFileVersion takes two arguments: the filespec ID of the file in question, and the minimal version of the file needed for this clause to be TRUE. The Installer obtains this information from the file’s 'vers' ID =1 resource. If no 'vers' resource exists, CheckFileVersion returns FALSE.
For example, to check for System version 6.0.5 or newer, use the following clause.
checkFileVersion{SysFileSpec, 6, 5, release, 0};
To check for System version 7.1 or newer, use the following clause.
targetFileSpecRsrcID A Target File Spec resource ID. (2-bytes)
countryCode A country code. (2 bytes)
DESCRIPTION
Use the CheckFileCountryCode clause to determine a file’s country code (the name 'country code' has recently been changed to region code). CheckFileCountryCode takes two arguments: the File Spec ID of the file in question, and the country/region code required. The Installer obtains this information from the file’s 'vers' resource. The country (MPW 3.1) /region (MPW 3.2) codes can be found in the MPW interface file SysTypes.r.
CheckTgtVolSize
CheckTgtVolSize{ minimumSize, maximumSize }
minimumSize The minimum size of the volume in Kbytes. (4-bytes)
maximumSize The maximum size of the volume in Kbytes. (4-bytes)
DESCRIPTION
Use the CheckTgtVolSize clause to check target disk size. Note that this check is for disk size (to distinguish floppy from hard disks), not available disk space. The Installer itself handles the case where the target has insufficient space to accomplish the installation. CheckTgtVolSize takes two arguments: the smallest and largest size disks possible. To match any size disk, the minimal and maximal target disk sizes are both zero. If the minimum size is greater than zero but the maximum size equals zero, only the minimal requirement is used. Note that there are three size pairs defined in InstallerTypes.r. If you use {floppy, floppy} then checkTgtVolSize will return TRUE for 400 or 800k floppy targets. If you use {hdFloppy, hdFloppy} then checkTgtVolSize will return TRUE for high density floppy (1.4mb) targets. If you use {hardDisk, hardDisk} then checkTgtVolSize will return TRUE for any target volume of 10mb or greater.
NOTE
Since RAM disks may be most any size, make sure your rules handle this situation correctly. u
CheckRuleFunction
CheckRuleFunction{ ruleFunctionCodeRsrcID }
ruleFunctionCodeRsrcID The resource ID of a RuleFunction resource (‘inrf’). (2-bytes)
DESCRIPTION
Rule functions provide you with the ability to extend the rule-based decision-making scheme using a custom code resource written by you or someone else. When the CheckRuleFunction clause is evaluated the code resource is called and its return result determines whether the clause returns TRUE or FALSE.
To call a rule function code resource, first create a Rule Function resource (‘inrf’) that describes how to call the code resource. The Rule Function resource is described in the “InstallerTypes.r” file and the code resource can include the file “RuleFunctionHeader.h”.
When the code resource is called, the code resource receives the parameter block:
typedef struct {
ProcPtr fCallBackProcPtr;
short fTargetVRefNum;
long fTargetFolderDirID;
short fSystemVRefNum;
long fSystemBlessedDirID;
long fRefCon;
} RuleFunctionPBRec, *RuleFunctionPBPtr;
NOTE
The fTargetFolderDirID field will be -1 if the Installer is using disk mode, the folder does not exist, or a target File Spec referencing the reserved folder path folder-user has not been referenced by in another rule clause prior to calling the CheckRuleFunction rule clause. u
The code resource should use the function declaration:
long RuleFunction( RuleFunctionPBPtr );
The function must return either a TRUE or FALSE value. Constants for these values are defined as:
#define kTRUERuleFunctionResult 1
#define kFALSERuleFunctionResult 0
s W A R N I N G
If you choose to create a sub-heap for each invocation of the Rule Function please read the section “Running with a Sub-Heap” within the Atom Extender portion of this document. You can enter 0 (zero) in the requested memory field to not create a sub-heap and run inside the Installer’s heap. s
AddAssertion
AddAssertion{ { assertionValueList } }
assertionValueList A list of 2-byte assertion values that you wish to set.
DESCRIPTION
Use the AddAssertion clause to set a list of 1 or more assertions. AddAssertion takes a list of assertion constants as arguments. The constants are uniquely defined Rez symbols. addAssertion always returns TRUE.
CheckAllAssertions
CheckAllAssertions{ { assertionValueList } }
assertionValueList A list of 2-byte assertion values that you wish to check.
DESCRIPTION
Use CheckAllAssertions to check all of the constants a given list are currently asserted. CheckAllAssertions takes a list of assertion constants as arguments. checkAllAssertions returns TRUE if all of the items in the list have been asserted.
CheckAnyAssertion
CheckAnyAssertion{ { assertionValueList } }
assertionValueList A list of 2-byte assertion values that you wish to check.
DESCRIPTION
Use CheckAnyAssertion to check if one or more constants are currently asserted. CheckAnyAssertion takes a list of assertion constants as arguments. CheckAnyAssertion returns TRUE if one or more of the items in the list have been asserted.
assertionValueList A list of 2-byte assertion values that you wish to check.
DESCRIPTION
CheckMoreThanOneAssertion is used to detect whether more than one constant in a list of constants are currently asserted. CheckMoreThanOneAssertion takes a list of assertion constants as arguments, and returns TRUE if more than one of the constants has been asserted. CheckMoreThanOneAssertion could be used, for example, to determine whether more than one printer is being installed. In that case, display a generic message reporting that “printer software” is being installed.
ClearAssertions
ClearAssertions{ { assertionValueList } }
assertionValueList A list of 2-byte assertion values that you wish to clear.
DESCRIPTION
Use the ClearAssertions clause to clear a list of one or more assertions. ClearAssertions takes a list of assertion constants as arguments. The constants are uniquely defined Rez symbols. ClearAssertions always returns TRUE.
CheckAllNonAssertions
CheckAllNonAssertions{ { assertionValueList } }
assertionValueList A list of 2-byte assertion values that you wish to check.
DESCRIPTION
Use CheckAllNonAssertions to check all of the constants a given list are currently not asserted. CheckAllNonAssertions takes a list of assertion constants as arguments. CheckAllNonAssertions returns TRUE if all of the items in the list are not currently asserted.
CheckAnyNonAssertion
CheckAnyNonAssertion{ { assertionValueList } }
assertionValueList A list of 2-byte assertion values that you wish to check.
DESCRIPTION
Use CheckAnyNonAssertion to check if one or more constants are currently not asserted. CheckAnyNonAssertion takes a list of assertion constants as arguments. CheckAnyNonAssertion returns TRUE if one or more of the items in the list are currently not asserted.
AddAuditRec
AddAuditRec{ targetFileSpecRsrcID, selector, value }
targetFileSpecRsrcID A Target File Spec resource ID. (2-bytes)
selector The selector. (4-bytes)
value The value (4-bytes)
DESCRIPTION
The AddAuditRec clause is used to add a record to a target file’s audit record. AddAuditRec takes three arguments: a File Spec ID for the target file, an audit selector, and an audit value.
targetFileSpecRsrcID A Target File Spec resource ID. (2-bytes)
auditSelector The selector. (4-bytes)
auditValueList A list of 4-byte values.
DESCRIPTION
The CheckAnyAuditRec clause is used to determine whether a given selector and value have been entered into the audit record of a target file (specified by the File Spec ID). CheckAnyAuditRec takes three arguments: a File Spec ID for the target file, an audit selector, and a list of audit values. If the value found in the audit resource for the specified selector is contained in the list of values the clause returns TRUE.
ReportVolError
ReportVolError{ errorString }
errorString String to display. (Pascal String)
DESCRIPTION
ReportVolError is used to report an error because of a problem with the target disk (not a hard disk, disk size too small, no system, et cetera). The ReportVolError clause reports an error message in the Easy Install or Custom Install message area. ReportVolError always returns TRUE, so it can be called multiple times in a script. Messages are concatenated, just as with addUserDescription. Up to four lines can be displayed. ReportVolError takes a single even-padded Pascal string as an argument. To insert the name of the volume into the string, place the characters "^O" in the desired place.
If the Installer evaluates a ReportVolError clause, the Easy Install or Custom Install dialog displays a caution icon, and the Install button is dimmed. If you use this clause, the user can still switch volumes.
NOTE
Calling ReportVolError from within the global framework may not work correctly for some scripts. Depending on the rules within the easy or custom framework, the Install button may still be enabled. To solve this, call ReportVolError from within the easy or custom framework. u
ReportSysError
ReportSysError{ errorString }
errorString String to display. (Pascal String)
DESCRIPTION
ReportSysError is used to report an error because of a problem with the system the Installer is running on (usually unsupported hardware or a fatal error). The ReportSysError clause reports an error message to the Easy Install or Custom Install screen, which ever shows first. ReportSysError always returns TRUE, so it can be called multiple times in a script. Up to four lines can be displayed. Messages are concatenated, just as with AddUserDescription. ReportSysError takes a single even-padded Pascal string as an argument. If the Installer evaluates a ReportSysError clause, the Easy Install or Custom Install dialog displays a caution icon, and the Install button is dimmed. If you use this clause, the user cannot switch or eject volumes from the interface and has only one option: to quit.
Easy Install Rule Clauses
AddPackages
AddPackages{ { assertionValueList } }
packageIDList A list of 2-byte package resource (‘inpk’) IDs.
DESCRIPTION
The AddPackages clause is used to return a set of packages to the Easy Install screen. AddPackages can be called multiple times from a script, and the packages are unioned together. AddPackages takes a list of package IDs as arguments. addPackages always returns TRUE.
AddUserDescription
AddUserDescription{ messageString }
messageString String to display. (Pascal String)
DESCRIPTION
Use AddUserDescription to add to the text which is shown in the Easy Install dialog. AddUserDescription takes a single even-padded Pascal string as an argument. The text to be added is appended to whatever text has been previously added using the AddUserDescription clause. Up to four lines can be displayed. AddUserDescription always returns TRUE. Note that the Installer will not supply introductory information so you need to say something like: “Click the Install button to install\n{your product here}.” Use the "\n" characters to insert a return character into the description string.
Custom Install Rule Clauses
AddCustomItems
AddCustomItems{ { integer packageRsrcID } }
packageRsrcID A list of 2-byte resource IDs of ‘inpk’ resources to append to the top level of the Custom Install list.
DESCRIPTION
The AddCustomItems rule clause appends the specified packages to the top level of the custom install list regardless of the setting of its showsOnCustom flag. Each package is appended in the order listed. All sub-packages with the showsOnCustom flag set are appended at the appropriate sub-level.
File Specification
This chapter describes how to create the script resources that specify the source and target file.
About File Specifications
Most atoms require a source and target file to be specified in order to carry out the action defined by the atom. For example, when using a File Atom to copy a file from the source disk to the target disk, a Target File Spec resource (‘intf’) and a Source File Spec resource (‘infs’) must be referenced from the atom.
NOTE
When performing installations from some network servers, it is necessary that all source files have a file creation and modification time stamp that has an even value for the seconds. If you intend for installation to be performed from network servers you should set the creation and modification times of all your source files to a value such as 12:00:00 PM. u
Specifying Target Files (‘intf’)
The goal of the Target File Spec is to specify where to install the file on the target disk. In most cases the scriptwriter can hard code the path to the target file using the various reserved folder path names, or in special cases, search for the file using a code resource.
The path to the target file that must start with a colon or one of two reserved tokens (special-xxxx or folder-user). Because the target volume name is not known at the time a script is written, the scriptwriter supplies a partial path name that begins in the root directory of the target disk.
Installing into Special Folders
A scheme is provided to support special folders such as the System Folder, the Apple Menu Folder, and other Folder Manager folders. The short-hand notation used to specify a folder manager folder is “special-xxxx”, where the “xxxx” is one of the defined special folder types. The special folder types currently defined for System 7.0 through 7.1 are as follows:
Type Folder
'macs' Blessed System Folder
'prnt' PrintMonitor Documents Folder
'strt' Startup Folder
'amnu' Apple Menu Items Folder
'extn' Extensions Folder
'pref' Preferences Folder
'ctrl' Control Panels Folder
'font' Fonts Folder (applies to System 7.1 only)
This means that if the fully qualified path to the system file on the target disk was “MyVolume:MyFolder:MySystemFolder:System”, then a reference to the special folder “special-macs” would be expanded by the installer to be “MyVolume:MyFolder:MySystemFolder.” For example, if you wanted to install the Finder file into the blessed folder on the system disk, you would use the path name “special-macs:Finder” in the File Spec. If a folder in the path name does not exist, the Installer creates it. The Installer supports the use of special folders even when running on systems which do not have Folder Manager functionality. For more information about the Folder Manager, refer to the Finder chapter in Inside Macintosh, Volume VI.
To support installing into pre-7.0 systems, the Installer will automatically map special folders to the System Folder. For example, if your target is the Extensions Folder then the Installer will change the destination to the System Folder rather than create an Extensions Folder. This also applies to rule clauses that reference a file spec. While this simplifies script writing for many files that go into special folders, it does not simplify DA installation.
Localized systems are supported through a defined algorithm for determining the correct special folder name by searching for the proper ‘fld#’ resource. Given a special folder type, the Installer searches for the type in a ‘fld#’ resource in the following order:
n Installer script file
n Target System file
n Installer application file
n Booted System file
Generally, the scriptwriter should not include a ‘fld#’ resource in the script so installations into localized System Folders will happen correctly.
Installing into the User-Selected Application Folder
The scriptwriter can easily install or remove files and resources from the application folder selected by the user. This reserved folder name should only be used in conjunction with the application folder interface mode. For example, to install the file “Demo Application” into the application folder the path name might be “folder-user:Demo Application”.
Managing Rollbacks on Multiple Target Volumes
With the ability to install onto more than one target volume at a time, a complete rollback is not possible unless the original files on all target volumes are maintained. This is not always possible due to available disk space on the target volumes. The Installer always saves the original System Folder files on the boot volume, but makes the saving of all other original files optional based on the amount of available disk space on each target volume. If there is enough space to save all original files on all target volumes the ‘Cancel’ button shows in the Status dialog thereby allow for a complete rollback, otherwise a ‘Stop’ button is shown.
Installing onto the Installer Volume
To support installation onto the Installer volume, the Installer must prevent source files from being disturbed. After the user clicks the Install button, the Installer determines whether any target file matches the location of a source file. If there is a conflict the user is alerted. This case is much more likely to happen when the scriptwriter allows the user to select the target application folder.
Setting the Finder flags and Dates
Format 1 of the ‘intf’ resource supports supplying the Finder flags, creation date and modification date to make target file specification of archived files easier. The Installer sets the values of a newly created file to the specified values in the ‘intf’. If the ‘intf’ is referenced from a File or ResMerge Atom and the file already exists the Finder flags, creation and modification dates will be updated. The Finder Flags in a File Atom will always override the Finder Flags specified in the ‘intf’ resource.
If you use an ‘infs’ or format 0 of the ‘intf’ the Installer continues to use the Finder flags, creation and modification date of the source file. In cases where the source file is a compressed archive, format1 version of the ‘intf’ is recommended. ScriptCheck will fill in the correct flags and dates if the file does not reference an Atom Extender. If an Atom Extender is being used, make sure to supply the appropriate ScriptCheck extension. To have ScriptCheck fill in the correct values, place a zero in the Finder flags field and 1 in the Creation Date and Modification Date fields. If the date field is zero or 1, the Installer reverts to the older method of determining the correct target date, such as with format 0 of the ‘intf’.
Specifying Source Files (‘infs’)
The goal of the Source File Spec is to describe where the file resides on the original distribution source disk.
Source Disk Search Path
Because of multiple disk installation capability, the semantics of the File Name field are a bit complex. Customers may have copied the distribution disks onto a file server and want to install from there, or they may have made floppy backup copies of the system disks provided by Apple and expect to be able to install from those. They might also want to set up a server that users can install from. In either case, the path name specified in the File Name field of the Source File Spec will probably be slightly off (e.g. the backup disks may not have the same names as the originals) so we need to be somewhat flexible when searching for a specific source file. In a Source File Spec, the full path name (including volume name) must be given in the File Name field, but it may not be used by the Installer exactly as given.
While the Installer is flexible as to exact volume names, it requires that disk contents be the same as what is specified in the script. The Installer uses the scripts to make a list of the volumes that are needed for the installation, and the files that should be on each volume. All files that are supposed to be on the same volume must be on the same volume, but that volume’s name may be different from the name given in the script. In addition, we relax this condition slightly to allow for hard disk and network installations. When the Installer needs a disk specified in the script, it searches in the following order:
n Search for a folder with the disk’s name at the same HFS level as the script.
n Search for a folder with the disk’s name at the script parent’s HFS level.
n Search for a folder with the disk’s name at the same HFS level as the Installer.
n Search for a folder with the disk’s name at the Installer parent’s HFS level
n Search for an online volume with the correct name.
n If the Installer was not launched from an AppleShare server volume, ask for a floppy disk or CD-ROM.
The disk that the Installer is on is a special case in our requesting disk and disk content strategies. If possible, the Installer’s disk is always the first disk that we copy files and resources from. Also, the contents of the Installer disk are checked for correctness before anything is deleted or copied. We recommend that scriptwriters (especially for system releases) have the most important files and resources to be copied on the Installer disk, since that’s the only disk that we can guarantee the user has. Otherwise, the Installer could start the installation, which includes deleting all appropriate target files and resources, and have to ask for a disk that contains a crucial file, in which case the user cancels out of the dialog, since that disk is for some reason not available, thereby aborting the installation, leaving the user worse off than before (i.e., a system that no longer boots). This, of course, does not happen when doing a live install
File spec. IDs of 0 should only be used for source files specifications for the deletion of files; when the noCopy and deleteOnInstall flags are set in the 'infs' resource
File Spec. Reference
This section describes the data structures and script resources needed to reference source and target files from atoms.
Resource Descriptions
The section describes the resource definitions for the target file specification resource (‘intf’) and the source file specification resource (‘infs’).
Target File Spec. Resource (‘intf’)
The new Target File Spec. resource contains a reference to an ‘insp’ script resource which describes the file searching code resource, much like the Atom Extender script resource does.
#define targetFileFlags \
boolean noSearchForFile, SearchForFile; \
boolean TypeCrNeedNotMatch, TypeCrMustMatch; \
fill bit[14] /* Reserved */
type 'intf' {
switch {
case format0:
key integer = 0; /* Target File Spec. Format version */
fileSpecFlags; /* Target File Spec. Flags */
literal longint; /* Target File Type */
literal longint; /* Target File Creator */
literal integer; /* Search Proc. Rsrc ID */
evenPaddedString; /* Target File Path */
case format1:
key integer = 1; /* Target File Spec. Format version */
fileSpecFlags; /* Target File Spec. Flags */
OSType; /* Target File Type */
OSType; /* Target File Creator */
unsigned hex integer; /* Target File Finder Flags */
unsigned hex longint; /* Target File Creation Date */
unsigned hex longint; /* Target File Mod. Date */
rsrcID; /* Search Proc. Rsrc ID */
evenPaddedString; /* Target File Path */
};
};
Flag descriptions
noSearchForFile/SearchForFile
Determines if the Search Procedure code resource will be called. Use the searchForFile flag to override the specified file path and use the list of files returned from the Search Procedure code resource.
TypeCrNeedNotMatch/TypeCrMustMatch
Determines if the specified type and creator must match the file found on the target disk. If the type and creator of the found file do not match those specified, the installation stops the installation. This is also true of any found files returned by the Search Procedure.
Field descriptions
Target File Type The file’s type if the Installer must create one during a copy. If the TypeCrMustMatch flag is used and an existing file is found, its type must match the type entered in this field. (4-bytes)
Target File Creator The file’s creator if the Installer must create one during a copy. If the TypeCrMustMatch flag is used and an existing file is found, its creator must match the creator entered in this field. (4-bytes)
Target Finder Flags The Finder flags to be given to a new file. If referenced from a ResMerge Atom, the Finder Flags are given to the existing file. The Finder flags specified in a File Atom always override this field. Only available in format 1. (2-bytes)
Target Creation Date The creation date to be given to a new file. If referenced from a File Atom or ResMerge Atom, the existing file is given this creation date. Leave as 0 to use the source file’s or today’s date. Set to 1 to have ScriptCheck update using the source file’s creation date. Only available in format 1. (4-bytes)
Target Mod. Date The modification date to be given to a new file. If referenced from a File Atom or ResMerge Atom, the existing file is given this modification date. Leave as 0 to use the source file’s or today’s date. Set to 1 to have ScriptCheck update using the source file’s modification date. Only available in format 1. (4-bytes)
Search Procedure Rsrc ID
The resource ID of an ‘insp’ resource, which describes the code resource to call to perform the target file search. (2-bytes)
Target File Path The partial path to the target file that must start with a colon or one of two reserved tokens (special-xxxx or folder-user). (even-padded Pascal string)
Source File Spec Resource (‘infs’)
The ‘infs’ script resource is referenced from atoms.
#define fileSpecFlags \
boolean noSearchForFile, searchForFile; \
boolean typeCrNeedNotMatch, typeCrMustMatch; \
fill bit[14]
type 'infs' {
literal longint; /* File Type */
literal longint; /* File Creator */
unsigned hex longint; /* Creation Date*/
fileSpecFlags; /* File Spec Flags */
evenPaddedString; /* Full Path */
};
Flags descriptions
noSearchForFile/searchForFile
Ignored in Installer 4.0.
typeCrNeedNotMatch/typeCrMustMatch
Determines if the type and creator contained in the File Creator and File Type fields must exactly match the source file on the source disk. Use the typeCrMustMatch flag to force the type and creator to match, otherwise the installation stops with an error.
Field descriptions
Source File Type The source file’s type. If the TypeCrMustMatch flag is used the source file’s type must match the type entered in this field. Otherwise, the user is told the source disk is bad and the installation is canceled. (4-bytes)
Source File Creator The source file’s creator. If the TypeCrMustMatch flag is used source file’s creator must match the creator entered in this field. Otherwise, the user is told the source disk is bad and the installation is canceled. (4-bytes)
Creation Date The creation date the source file must have, otherwise the installation is stopped. Values of 0 or 1 are considered to match any creation date. (4-bytes)
Source File Path The full path to the source file. (even-padded Pascal string)
About File Searching (‘insp’)
Whenever you want to update or delete a file on the user’s disk but don’t know where the file will reside, you’ll need to search for it at installation time. For those File and Resource atoms you wish to search for the target file, attach a Search Procedure (‘insp’) script resource to the new Target File Spec. (‘intf’) script resource, then reference the ‘intf’ resource from the atom just as you would the older ‘infs’ script resource. Setting the searchForFile flag in the ‘intf’ resource will tell the Installer to call the code resource at the appropriate time. The built-in searching feature of the Installer will be removed and the searchForFile flag in the present ‘infs’ resource will be ignored.
The actual searching code will be supplied by you, the scriptwriter, in a code resource whose type and ID is specified in the ‘insp’ resource.
Using File Searching with File and Resource Atoms
The file searching code resource is given a pointer to a parameter block containing useful information about the Installer’s environment. The search routine performs a search for the desired file(s), then passes back a list of those files it has found, including a result code to tell the Installer whether to continue or stop.
The search routine’s task is to create and return a handle to an array of FoundFileRec records in the parameter block’s fFoundFiles field. The array should contain zero or more FoundFileRec records that specify each target file to act upon. The number of elements in the array is determined by the size of the handle. If the array has no elements, then the atom is ignored. If one FoundFileRec element is specified, then the atom (file, resource, or font atom ) is processed normally with the designated target file. If more than one FoundFileRec element is in the array, the atom is duplicated for each element.
The files that are returned to the Installer may or may not already exist. The Installer will verify that the volume and directory exist and are valid, and that the file name does not conflict with an existing directory name. If the file does not exist the Installer will create one, if necessary.
Using File Searching with Rule Clauses
File searching can also be used with Target File Specs that are referenced from rule clauses. If a Target File Spec returns more than one found file, the rule clause is duplicated for each valid file. The duplicated rule clauses are “anded” with the original rule clause. Therefore, in order for the original rule clause to return TRUE, every duplicated rule clause must also return TRUE.
Allowable Installer Functions During File Searching
While your file searching code resource is executing, you can call selected Installer functions.
Allowable Installer functions:
n Memory functions: INewHandle, IDisposHandle, ILockHandle, IUnLockHandle.
n Action Handler functions: RegisterAction.
File Searching Reference
This section describes the data structures and new script resources needed to support target file searching.
Data Structures
This section describes the function interface and parameter block passed to the Search Procedure code resource.
The Search Procedure must return a handle to an array of records describing the files it found. This array handle is defined as:
typedef struct {
short vRefNum;
long parID;
Str63 name;
short fReferenceID; /* Reserved for internal use. */
The file search code resource is passed a pointer to a parameter block containing useful information. Your code resource will want to return a handle to a list of found files in the fFoundFileArray field.
typedef struct {
—> ProcPtr fCallBackProcPtr;
—> short fTargetVRefNum;
—> long fTargetFolderDirID;
—> short fSystemVRefNum;
—> long fSystemBlessedDirID;
—> long fRefCon;
—> OSType fFileSpecType;
—> OSType fFileSpecCreator;
—> long fFileSpecCrDate;
—> Str255; fFileSpecPath;
<- FoundFileArrayHdl fFoundFilesArray;
} SearchProcedurePBRec, *SearchProcedurePBPtr;
Field descriptions
fCallBackProcPtr A pointer to the Installer’s dispatch routine. You’ll need to pass this field as a parameter to glue routines that provide access to Installer functions.
fTargetVRefNum The target disk’s vRefNum. When allowing the user to select a target application folder, this is the volume on which the folder resides.
fTargetFolderDirID The target application folder’s directory ID. This value is -1 if the user cannot select a target application folder. Target File Specs that use the reserved folder path folder-user will be placed in this folder.
fSystemVRefNum The system disk’s vRefNum. Target File Specs that use the reserved folder path special-xxx will be placed in the System Folder on this volume.
fSystemBlessedDirID The directory ID of the System Folder on the disk with the refNum fSystemVRefNum. This directory is not necessarily the currently active System Folder.
fRefCon A 4-byte value defined by the scriptwriter in the ‘insp’ script resource.
fFileSpecType The value from the Target File Type field of the Target File Spec.
fFileSpecCreator The value from the Target File Creator field of the Target File Spec.
fFileSpecCrDate The value from the Target File Creation Date field of the Target File Spec.
fFileSpecPath The value from the Target File Path field of the Target File Spec.
fFoundFilesArray A handle to an array of found target files that is created and filled by the code resource.
Resource Description
The ‘insp’ script resource is referenced from the new Target File Spec. It defines how to call the code resource that will perform the actual search.
type 'insp' {
switch {
case format0:
key integer = 0; /* Search Procedure Format version */
unsigned integer; /* Search Procedure Flags */
literal longint; /* Search Procedure Code Rsrc Type */
literal integer; /* Search Procedure Code Rsrc ID */
literal longint; /* RefCon Value */
literal longint; /* Required Free Memory */
evenPaddedString; /* Search Procedure Summary */
};
};
Field descriptions
Search Procedure Flags Currently reserved for use by Apple Computer, Inc. (2-bytes)
Search Procedure Code Rsrc Type
The type of the code resource that will be called to perform the search. (4-bytes)
Search Procedure Code Rsrc ID
The ID of the code resource that will be called to perform the search. (2-bytes)
RefCon Value The value that will be passed to the code resource in the fRefCon field of the Search Procedure parameter block. (4-bytes)
Required Free Memory The minimum number of free bytes the Search Procedure code resource needs in its own heap to make local allocation of memory using Macintosh OS/Toolbox routines. Enter 0 (zero) to not create a sub-heap and run inside the Installer’s heap. Please see warnings about using sub-heaps in the Atom Extender section if you specify a value other than 0. (4-bytes)
Search Procedure Summary
An optional string briefly describing the purpose of this Search Procedure. This string is never displayed to the user. (even-padded Pascal string)
About the Disk Order Resource (‘indo’)
By default, the Installer requests disks from the user using the order of the atoms specified in the script. This ordering is displayed in the status dialog. With more than just a few atoms, it can be very difficult to control the order of disks. To make this easier, if an Installer Disk Order resource exists in the script (resource type 'indo'), this resource is used to determine the ordering of the disks. The format of the 'indo' resource is given below. The resource contains a list of Pascal strings that are the names of the source disks. These names must exactly match the names of the volumes given in the source and target paths within the File Specs.
For example, let’s say you have created a two disk set that uses one floppy disk and one CD volume. Your ‘indo’ might look like this:
resource 'indo' (1000) {
format1 {{
kExpectFloppyDisk,
"Installer Disk",
kExpectCDVolume,
"Applications CD"
}};
};
Specifying the expected type of source disk just helps the Installer know which type of disk drive to make available to insert the requested source disk. This feature does not affect the user’s ability to create network installation folders on an AppleShare server volume.
Disk Order Reference
Resource Description
Format 0 of the new ‘indo’ resource:
#define SrcDiskType \
integer \
kExpectFloppyDisk = 0, /* It’s a floppy Disk */ \
kExpectCDVolume = 1, /* It’s a CD */ \
kExpectFoldersOnVol = 2 /* It’s a folder */
type 'indo' {
switch {
case format1:
key integer = 1;
integer = $$Countof(SrcVolArray);
array SrcVolArray {
SrcDiskType; /* Source Disk Type */
evenPaddedString; /* Source Disk Name */
};
};
};
Field descriptions
Source Disk Type The expected source disk type. Currently, a floppy disk; CD or folders on a CD, HD, or AppleShare volume. The Installer primarily uses this information to determine which type of disk to eject to make room for the requested source disk. For example, if the requested source disk is expected to be a CD and all CD drives are full, then one of the CDs will be ejected. (2-bytes)
Source Disk Name The name of the source disk. The name can end in a colon if you wish. (2-bytes)
Installer Functions
This chapter describes the routines that are available when running as an external code resource within the Installer environment.
About Installer Functions
Installer functions allow the code resource writer to communicate with the Installer and use utility routines provided by the Installer. Some of the routines are the essential mechanism for communicating with the Installer, such as when decompressing files during installation. These routines are often limited to being called from specific code resources. Other routines may be available all the time, either as a means to getting information from the Installer or as helpful utility routines.
All Installer callback functions are actually glue routines that you must include in your code to access the proper routines inside the Installer. In the discussion of each routine the name of the header file and glue file is mentioned.
Data I/O Routines
This section describes the routines available to manage reading and writing atom data. Most of these routines are only available in Atom Extenders. These routines function very similar to high-level File Manager routines. Consult Inside Macintosh: File s for an overview of topics such as positioning marks in files.
count The number of bytes to read from the source data. After the call, the actual number of bytes read is returned in count.
bufferPtr A pointer to a buffer of at least size count.
DESCRIPTION
The ReadSourceData function reads the specified number of bytes from the source data beginning at the current position. The supplied pointer must have already been allocated to at least the size of count.
See interface file “AtomExtenderHeader.h” and glue code file “AtomExtenderCBGlue.c”.
RESULT CODES
kNotImplementedErr 30901 Routine not currently implemented
count The number of bytes to write to the target at the current position.
bufferPtr A pointer to a buffer of at least size count.
DESCRIPTION
The WriteTargetData function writes the specified number of bytes from the supplied buffer to the target beginning at the current position. The data is not immediately written to the target file, but rather is buffered using the Installer heap or MultiFinder temporary memory. This reduces our need for the target disk, which is especially important when installing onto floppy disks.
IMPORTANT
Since there is overhead associated with each call to WriteTargetData, calls to write very small amounts of data (less than 1K) should be avoided.
See interface file “AtomExtenderHeader.h” and glue code file “AtomExtenderCBGlue.c”.
RESULT CODES
kNotImplementedErr 30901 Routine not currently implemented
count The number of bytes to read from the target data. After the call, the actual number of bytes read is returned in count.
bufferPtr A pointer to a buffer of at least size count.
DESCRIPTION
The ReadTargetData function reads the specified number of bytes from the target data beginning at the current position. The supplied pointer must have already been allocated to at least the size of count.
IMPORTANT
The ReadTargetData function can only be called while in a Version Compare code resource that was referenced from a Resource Atom. Calling this function at any other time will return a kNotImplementedErr error.
See interface file “AtomExtenderHeader.h” and glue code file “AtomExtenderCBGlue.c”.
RESULT CODES
kNotImplementedErr 30901 Routine not currently implemented
theLength On output, contains the length of the source data.
DESCRIPTION
The GetSourceDataPos function returns the length of the source data.
See interface file “AtomExtenderHeader.h” and glue code file “AtomExtenderCBGlue.c”.
RESULT CODES
kNotImplementedErr 30901 Routine not currently implemented
noErr 0 No error
Memory Routines
This section describes the routines available to manage static memory. Some code resources can pass back a handle to static memory so the code resource can communicate between invocations of the code resource. Generally, these routines are available all the time.
newHandleSize The requested size to allocate the handle.
DESCRIPTION
The INewHandle function attempts to allocate a handle of the specified size. If the memory is not immediately available, the Installer writes out any buffered target data to the appropriate target disk, then tries again. The resulting handle is NULL if the handle could not be allocated.
Use INewHandle when you want to pass information between invocations of an Atom Extender using the fStaticDataHandle of the parameter block.
See interface file “InstallerMemoryFuncsHeader.h” and glue code file “InstallerMemoryCBGlue.c”.
IMPORTANT
Always use IDisposHandle to release a handle allocated using INewHandle. Always use IHLock and IHUnLock when locking and unlocking a handle allocated using INewHandle.
RESULT CODES
kNotImplementedErr 30901 Routine not currently implemented
noErr 0 No error
memFullErr -108 Not enough room in the Installer’s or MultiFinder’s heap zone
The IDisposHandle function disposes the handle in the parameter storageHandle. The handle could have been allocated using the Installer’s INewHandle function, or with any other Macintosh Toolbox routine.
See interface file “InstallerMemoryFuncsHeader.h” and glue code file “InstallerMemoryCBGlue.c”.
RESULT CODES
kNotImplementedErr 30901 Routine not currently implemented
noErr 0 No error
nilHandleErr -109 NULL master pointer
memWZErr -111 Attempt to operate on a free block
IHLock
void IHLock( CallBackProcPtr pCallBackProcPtr,
Handle storageHandle );
pCallBackProcPtr The callback pointer.
storageHandle The handle to lock.
DESCRIPTION
The IHLock function locks the specified handle.
See interface file “InstallerMemoryFuncsHeader.h” and glue code file “InstallerMemoryCBGlue.c”.
IMPORTANT
Always use IHLock to lock a handle allocated using INewHandle.
RESULT CODES
kNotImplementedErr 30901 Routine not currently implemented
noErr 0 No error
nilHandleErr -109 NULL master pointer
memWZErr -111 Attempt to operate on a free block
IHUnLock
void IHUnLock( CallBackProcPtr pCallBackProcPtr,
Handle storageHandle );
pCallBackProcPtr The callback pointer.
storageHandle The handle to lock.
DESCRIPTION
The IHUnLock function unlocks the specified handle.
See interface file “InstallerMemoryFuncsHeader.h” and glue code file “InstallerMemoryCBGlue.c”.
IMPORTANT
Always use IHUnLock to unlock a handle allocated using INewHandle.
RESULT CODES
kNotImplementedErr 30901 Routine not currently implemented
noErr 0 No error
nilHandleErr -109 NULL master pointer
memWZErr -111 Attempt to operate on a free block
Misc. Routines
This section describes various miscellaneous routines available.
param0…param3 A pointer to data or 4-byte value used to send information to the Action Handler about the action.
resultPtr A pointer to a variable that the Action Handler can send information back to the caller. The format of the data structure is defined individually for those actions that allow modification to the result.
DESCRIPTION
The RegisterScriptAction function registers an action with the Installer, which will be immediately given to all loaded Action Handlers. This function is made available to help code resource writers easily send text messages to the Installer Debugger, using the action class kDebuggingAction, and the action identifier kGenericDebugActID.
See interface file “ActionHandlerHeader.h” and glue code file “ActionHanderCBGlue.c”.
IMPORTANT
RegisterScriptAction cannot be called from within an ActionHandler code resource.
Calling the SuspendWaitCursor function stops the wait cursor and returns the cursor to an arrow. Use the ResumeWaitCursor to begin the wait cursor again. This is handy if you want to show a dialog from a code resource during the installation.
See interface file “ActionAtomHeader.h” and glue code file “ActionAtomCBGlue.c”.
Calling the IncrementStatusBar function increments the status bar during long waits inside your code resource. Most often you’ll use this in your Action Atom code resource. Upon entry to your Action Atom you are given 100 status increments to use to show progress while executing a single Action Atom. The Installer limits the bar so you don’t have to worry about incrementing the bar too far.
See interface file “ActionAtomHeader.h” and glue code file “ActionAtomCBGlue.c”.
Miscellaneous Features
This chapter describes miscellaneous features of Installer 4.0 available to scriptwriters.
About Action Handlers
Action Handlers allow external code resources to be called in response to specific actions in a “debug” version of the Installer. An action might provide information about which files will be replaced during the installation, the reason the script cannot be read, the outcome of Easy Install or Custom Install rule evaluation, or why the installation failed.
The Action Handler code resource should be located in the script file. A “debug” version of the Installer is available that has the necessary code to look for and send actions to all Action Handlers found in the Installer application file and script file.
Apple supplies an Installer Debugger implemented as an Action Handler. Scriptwriters can write other Action Handlers as needed.
Writing an Action Handler
When the Installer first finds and opens the Installer script file it looks for all resources in the script and Installer file with the type ‘inah’. The ‘inah’ resource contains the type and ID is of the actual Action Handler code resource. Each of the code resources are loaded into the Installer’s heap and detached.
An Installer action consists of an action class ID and an action identifier. When a loggable action occurs in the Installer, each Action Handler code resource is called with a pointer to a Action Handler parameter block. Action Handlers will be called in order of their resource ID (‘inah’ rsrc ID ). When called the Action Handler can handle the action however it desires, but remember that other Action Handlers may be called before and after yours. Depending on the action the Action Handler may be able to modify the result value to effect the progress of the Installer, such as when evaluating rules.
The Action Handler receives an initialize action when the script is first opened, and a close action when the Installer quits. Action Handlers can use the initialize action to allocate persistent memory to communicate between invocations of the same Action Handler. The Action Handler also receives all events that pass through the Installer.
Action Handler Runtime Environment
During execution the Action Handler shares memory space with the Installer. Local memory allocation using Memory Manager calls will come from the Installer’s heap. Action Handlers should use the Installer’s INewHandle routine to allocate memory that it wishes to persist between calls to the Action Handler.
Action Handler Reference
This section describes the data structures, resource descriptions and defined actions needed to use or write Action Handlers.
Data Structures
This section describes the function prototype, parameter block structure and defined actions.
Function Interface
The Installer calls your Action Handler code resource assuming the following function declaration.
long HandleAction( ActionHandlerPBPtr theActionHandlerPB );
The Action Handler writer should look at the actionClassID and actionIdentifier to determine how to react to the action. The four parameters, fParam0, fParam1, fParam2 and fParam3 will contain additional information depending on the action. You’ll need to include either “ActionHandlerHeader.h” or “ActionHandlerHeader.p” to allow access to the defined action class IDs and action identifiers.
Parameter Block
The Installer calls your Action Handler code resource, passing it the following parameter block.
typedef struct{
<-> Handle fStaticDataHdl;
—> ProcPtr fCallBackProcPtr;
—> short fTargetVRefNum;
—> long fTargetFolderDirID;
—> short fSystemVRefNum;
—> long fSystemBlessedDirID;
-> short fActionClassID;
-> short fActionIdentifier;
-> void* fParam0;
-> void* fParam1;
-> void* fParam2;
-> void* fParam3;
-> void* fResultPtr;
} ActionHandlerPB, *ActionHandlerPBPtr;
Field descriptions
fStaticDataHdl A handle created by the Action Handler using INewHandle to save information between calls to this Action Handler code resource. The field is always NULL when your Action Handler is initialized. You can assign a value to this field during any call to the Action Handler, and receive the same value in this field during the next action.
fCallBackProcPtr A pointer to the Installer’s dispatch routine. You’ll need to pass this field as a parameter to Installer function glue routines.
fTargetVRefNum The target disk’s vRefNum. When allowing the user to select a target application folder, this is the volume on which the folder resides.
fTargetFolderDirID The target application folder’s directory ID. This value is -1 if the user cannot select a target application folder. Target File Specs that use the reserved folder path folder-user will be placed in this folder.
fSystemVRefNum The system disk’s vRefNum. Target File Specs that use the reserved folder path special-xxx will be placed in the System Folder on this volume.
fSystemBlessedDirID The directory ID of the System Folder on the disk with the refNum fSystemVRefNum. This directory is not necessarily the currently active System Folder.
fActionClassID The action’s class ID (i.e. a script error.). Available class IDs are defined in “ActionHandlerHeader.h” and “ActionHandlerHeader.p”.
fActionIdentifier The action’s identifier (i.e. couldn’t find script resource.). Available identifiers are defined in “ActionHandlerHeader.h” and “ActionHandlerHeader.p”.
fParam0..fParam3 Parameters containing extra information for the action. Contents of the parameters are defined in “ActionHandlerHeader.h” and “ActionHandlerHeader.p” for each action.
fResultPtr A pointer to the result variable. This is used by some actions to enable the Action Handler to change the result, such as with rules and rule clauses.
Actions
The following is listing of the current actions supported by the Installer. See the file “ActionHandlerHeader.h” file for a complete description of all actions.
Action Class: kDebuggingAction
kInitializationActID
kCloseActID
kStdEventActID
kGenericDebugActID
Action Class: kScriptAction
kPackageNotFoundActID
kAtomNotFoundInPackageActID
kFrameworkNotFoundActID
kRuleNotFoundActID
kFileSpecNotFoundActID
kFileSpecIsBadActID
kCouldNotOpenScriptActID
kFileSpecIDIsBadActID
kAtomIDIsBadActID
kNotEnoughMemoryToReadActID
kSubHeapToSmallActID
kFileSpecNotFndWithRefActID
kVersCompareNotFoundActID
kSearchProcNotFoundActID
kRuleFunctionNotFoundActID
Action Class: kFireRulesAction
kFrameworkActID
kRuleResultActID
kRuleClauseResultActID
Action Class: kTargetAction
kTgtFileNotFoundActID
kTgtFileLockedActID
kTgtErrForFileAtomActID
kTgtErrForRsrcAtomActID
kTgtErrForFontAtomActID
kTgtMatchesSrcErrActID
Action Class: kSourceAction
kSrcFileNotFoundActID
kSrcErrForFileAtomActID
kSrcErrForRsrcAtomActID
kSrcErrForFontAtomActID
kSrcErrForFolderAtomActID
kSrcErrForResMergeAtomActID
Action Class: kExtenderAction
kExtCodeRsrcNotFoundActID
kExtenderRsrcNotFoundActID
kCallBackNotAvailableActID
kExtenderResultActID
kA5NotSetCorrectlyActID
kTgtSetupProcNotFoundActID
kVersCodeRsrcNotFoundActID
kActionAtomCodeRsrcNFActID
kSearchProcCodeRsrcNFActID
kSearchProcBadFileActID
kRuleFuncCodeRsrcNFActID
kLowModuleSetupMemoryActID
kNoModuleSetupMemoryActID
Action Class: kProgressAction
kClickedInstallActID
kClickedRemoveActID
kInstallationResultActID
kRemovalResultActID
kActionAtomResultActID
Action Class: kFileProgressAction
kFileCopiedID
kFileNotCopiedID
kFileNotCopiedNewerLeftID
kFileNotCopiedLockedID
kFileUpdatedID
kFileNotUpdatedKeptExistID
kFileNotUpdatedNotExistID
kFileRemovedID
kFileNotRemovedID
kFileNotRemovedNoExistID
kFileNotRemovedLockedID
kFileSetLockedID
Action Class: kRsrcProgressAction
kRsrcCopiedID
kRsrcNotCopiedID
kRsrcNotCopiedNewerLeftID
kRsrcNotCopiedNotTargetID
kRsrcNotCopiedProtectedID
kRsrcUpdatedID
kRsrcNotUpdatedKeptExistID
kRsrcNotUpdatedLockedID
kRsrcNotUpdatedNotExistID
kRsrcNotUpdatedProtectedID
kRsrcRemovedID
kRsrcNotRemovedID
kRsrcNotRemovedNoExistID
kRsrcNotRemovedProtectedID
kRsrcNotRemovedLockedID
Action Class: kFontProgressAction
kFontCopiedID
kFontNotCopiedID
kFontUpdatedID
kFontNotUpdatedKeptExistID
kFontNotUpdatedLockedID
kFontNotUpdatedNotExistID
kFontNotUpdatedProtectedID
kFontRemovedID
kFontNotRemovedID
kFontNotRemovedNoExistID
kFontNotRemovedLockedID
kFontNotRemovedProtectedID
Action Class: kFolderProgressAction
kFolderCopiedID
Action Class: kResMergeProgressAction
kResMergeCopiedID
Resource Description
The template of the Action Handler resource is shown below.
Action Handler Flags Currently reserved for use by Apple Computer, Inc. (2-bytes)
Action Handler Code Rsrc Type
The resource type of the Action Handler code resource. (4-bytes)
Action Handler Code Rsrc ID
The resource ID of the Action Handler code resource. (2-bytes)
Minimal Required Memory The minimum number of free bytes the Action Handler code resource needs during execution. (4-bytes)
Handler Summary An optional string briefly describing what this Action Handler does. This string is never displayed to the user. (even-padded Pascal string)
About the Installer Version Resource (‘invs’)
You may want to ensure that the version of the Installer that you used for development and testing and that you shipped is the one that is launched. To do so, add an 'invs' Installer Version resource to specify the specific Installer version needed for your script. If you require Installer 4.0 and a different version is launched and the version specified in this resource is 4.0 then the Installer will display a dialog saying something like “The Installer document [your document's name here] requires version [invs version number here] of the Installer application. Try opening the Installer application that is in the same folder as this Installer document.”
The Installer uses the four hex bytes that specify the version number to compare against its own version. The string is used only in the dialog that is displayed when the two versions do not match.
The following is an example 'invs' resource for Installer 4.0.3.
resource 'invs' (1) {
format0 {
0x4,
0x03,
release,
0x0,
"4.0.3"
}
};
Installer Version Reference
Resource Description
Format 0 of the ‘invs’ resource:
type 'invs' {
switch {
case format0:
key integer = 0;
hex byte; /* Major revision in BCD */
hex byte; /* Minor revision in BCD */
hex byte; /* Release Stage */
hex byte; /* Release Number */
pstring; /* Short Version Number String */
};
};
Field descriptions
Major Revision The major version number. (2-bytes)
Minor Revision The minor version number. (2-bytes)
Release Stage The release stage. Four release stage constants are defined in the InstallerTypes.r file: development, alpha, beta, final and release. (2-bytes)
Release Number The release number. (2-bytes)
Short Version Number String
Text description of version number. (even-padded Pascal string)
About the Script Size Resource (‘insz’)
Use of the new script resource, ‘insz’ with an ID of 1 is recommend for scripts over 10K in size. When the script resources are loaded into memory, they actually go into a sub-heap inside of the Installer’s main heap. This improves Memory Manager performance on older machines. In previous versions of the Installer, the size of this sub-heap was always overestimated to account for possibly compressed resources in the script file. This older scheme has the potential for wasting precious Installer heap memory, requiring a larger application partition.
ScriptCheck 4.0 calculates this value and automatically places this resource into your script. The size calculated is calculated using the following script resource types: 'inaa', 'infa', 'inra', 'inff', 'inrm', 'intf', infs', 'inpk', 'inrl', 'infr', 'inex', 'invc', 'insp', 'inat', 'inbb', 'indo', incd', 'insz', 'icmt', 'inpc', 'inr#'.
Script Size Reference
Resource Description
Format 0 of the ‘invs’ resource:
type 'insz' {
switch {
case format0:
key integer = 0; /* Format version */
unsigned longint; /* Script Sub-Heap Size in bytes */
};
};
Field descriptions
Script Sub-Heap Size The size in bytes the script resources will require when loaded into memory. This value is used to create an optimally sized sub-heap for the Installer script resources. (4-bytes)
About the Script Creation Date Resource (‘incd’)
The script creation date resource holds a copy of the script file’s creation date field. This value is used by the Installer to correctly find and verify the source files when copied to an AppleShare server. Because the creation date of the source files may have been changed during the copy, the Installer uses the creation date in the ‘incd’ resource to calculate a delta value using the script’s creation date stored in the file by the File Manager. Without this resource, the user may get an error after beginning the installation saying that the source files could not be found.
ScriptCheck automatically updates or adds this resource to your script.
Script Creation Date Reference
Resource Description
The ‘incd’ resource:
type 'incd' {
unsigned longint; /* Script Creation Date in seconds. */
};
};
Field descriptions
Script Creation Date The original creation date in seconds of the script file. (4-bytes)
Installation Topics
This chapter discusses information that may help some scriptwriters keep out of trouble and provide solutions to unique situations.
Installing Desk Accessories
Installing into Pre-7.X Systems
Desk Accessories are installed into the System file as 'DRVR' resources. The installer will take care of all of the DA's owned resources. Following is an example of a resource atom used to install a desk accessory. Flags with the comment /* your choice */ can be either value.
resource 'inra' (raDAtoInstall) {
format0 {
deleteWhenRemoving, /* your choice */
deleteWhenInstalling, /* remove the outdated DA */
copy, /* Copy rsrc to destination */
tgtRequired, /* Target file need already exist to install */
updateExisting, /* your choice */
copyIfNewOrUpdate, /* your choice */
ignoreProtection, /* your choice */
srcNeedExist, /* Rsrc needs to exist on source disk */
fsSourceDA, /* Source file spec where to get rsrc */
'DRVR', /* Resource type */
0, /* Resource source id (must be 0) */
0, /* Resource target id (must be 0) */
0, /* atom size (filled in by ScriptCheck) */
"Desk Accessory: DA name", /* Atom description */
"\0x00DA Name" /* Resource name */
};
};
When installing DA's into System 6.0.x and prior, use the 'deleteWhenInstalling' flag in conjunction with the 'updateExisting' flag. In general, always use the 'deleteWhenInstalling' option when using the 'updateExisting' flag. Conversely, use the 'dontDeleteWhenInstalling' flag with the 'keepExisting' flag.
Installing into System 7.X
Desk Accessories are installed into the Apple Menu Items Folder that is found in the System Folder. Each Desk Accessory is contained in a single file. Use a typical 'infa' to install your DA.
Glossary
buffering The act of storing up atom data to be written to the target disk later in the installation. This reduces the Installer’s need for the target disk, in case the disk is ejectable.
folder-user A reserved target pathname used in target file specs to specify the user-selected application folder.
“live” installation An installation where a file in the currently active System Folder will be deleted or modified. This type of installation always requires that all other applications are quit before beginning the installation. The original file is never touched, and is saved to provide for cancellation of the installation.
part The portion of atom data that is given to an Atom Extender during a kBeforePart and kAfterPart message. May or may not be the same as the source piece.
preflighting The tasks performed after the user clicks the “Install” button and before the status dialog appears. Some of the tasks performed are: checking for locked files, checking for protected resources, calculating required target disk space, and checking if a target file equates to a source file.
special-xxxx A reserved target pathname used in target file specs to specify a special folder, usually a folder in the System Folder. The name of the folder is found in a ‘fld#’ resource using the folder type ( where ‘xxxx’ is the type of the folder).
source pieces The portions of atom data on the source disk that will be combined during the installation to create the target data. For example, a large file is split into three files so they will fit onto floppy disks. Each of the three files would be considered a source piece.
strike The combination of size and style of a font.
Ê d ˇ ˇˇˇˇ d
d , Palatino
. +66Installer 4.0.3 *Technical Guide , Times
$ (– 6
+ ®
(Ô 6+Document Version 1.23 - September 14, 1994 ˇ;‰ d ˇ ˇˇˇˇ d
d , Palatino
. +~-Table of Contents , Helvetica
(Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )¶2
° d ONLN d c 6 u À ( q 6Scripting Overview " ° ∂ u 4 u0 ° ∂ ° ∂
° d ONLN dˇˇ *Scripting Overview ° d ONLN dˇˇ )Z ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` .............................. ° d ONLN dˇˇ ( ê ° d ONLN dˇˇ (
6 ° d ONLN dˇˇ ( ã H-Script Resources for Displaying the Interface ° d ONLN dˇˇ )à ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.................. ° d ONLN dˇˇ ( ã ° d ONLN dˇˇ )˜6 ° d ONLN dˇˇ ( ó H'Script Resources for Describing Actions ° d ONLN dˇˇ )Æ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................ ° d ONLN dˇˇ ( ó ˆ ° d ONLN dˇˇ ( ó
7 ° d ONLN dˇˇ ( £ H Independent Script Resources ° d ONLN dˇˇ )Ñ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`
.......... ° d ONLN dˇˇ ( £ À ° d ONLN dˇˇ ( £
8 ° d ONLN dˇˇ ( Ø 6Installation Timeline ° d ONLN dˇˇ )c ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`........................... ° d ONLN dˇˇ ( Ø ò ° d ONLN dˇˇ ( Ø
9 ° d ONLN dˇˇ ( ª H Launching ° d ONLN dˇˇ )0 ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...... ° d ONLN dˇˇ ( ª w ° d ONLN dˇˇ ( ª
9 ° d ONLN dˇˇ ( « HInstaller Rule Evaluation ° d ONLN dˇˇ )u ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`............... ° d ONLN dˇˇ ( « º ° d ONLN dˇˇ ( «
9 ° d ONLN dˇˇ ( ” H Preflighting ° d ONLN dˇˇ )9 ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`... ° d ONLN dˇˇ ( ” Å ° d ONLN dˇˇ ( ”
10 ° d ONLN dˇˇ ( fl H Preparation to Install/Remove ° d ONLN dˇˇ )ç ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`....... ° d ONLN dˇˇ ( fl ‘ ° d ONLN dˇˇ ( fl
10 ° d ONLN dˇˇ ( Î H1Reading Source File, Rsrc or Font (for each atom) ° d ONLN dˇˇ )€ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`
............. ° d ONLN dˇˇ ( Î# ° d ONLN dˇˇ )Á11 ° d ONLN dˇˇ ( ˜ H1Writing Target File, Rsrc or Font (for each atom) ° d ONLN dˇˇ )€ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`
............. ° d ONLN dˇˇ ( ˜# ° d ONLN dˇˇ )Á11 ° d ONLN dˇˇ ( H
Finalizing ° d ONLN dˇˇ )0 ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...... ° d ONLN dˇˇ ( x ° d ONLN dˇˇ (
11
° d ONLN dˇˇ (& 6Installer Human Interface " ° ∂ * 4*0 ° ∂ ° ∂
° d ONLN dˇˇ *Easy Install Interface ° d ONLN dˇˇ )c ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`........................... ° d ONLN dˇˇ (4 ò ° d ONLN dˇˇ (4
12 ° d ONLN dˇˇ (@ H Using the Target Disk Interface ° d ONLN dˇˇ )ê ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...... ° d ONLN dˇˇ (@ ◊ ° d ONLN dˇˇ (@
13 ° d ONLN dˇˇ (L H&Using the Application Folder Interface ° d ONLN dˇˇ )± ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`........................... ° d ONLN dˇˇ (L ˘ ° d ONLN dˇˇ (L
13 ° d ONLN dˇˇ (X HButtons ° d ONLN dˇˇ )$ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`
.......... ° d ONLN dˇˇ (X j ° d ONLN dˇˇ (X
13 ° d ONLN dˇˇ (d 6Custom Install Interface ° d ONLN dˇˇ )o ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`....................... ° d ONLN dˇˇ (d £ ° d ONLN dˇˇ (d
14 ° d ONLN dˇˇ (p HCustom Install List ° d ONLN dˇˇ )W ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`......................... ° d ONLN dˇˇ (p û ° d ONLN dˇˇ (p
14 ° d ONLN dˇˇ (| H-Selected Size and Disk Space Available Values ° d ONLN dˇˇ )€ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`
............. ° d ONLN dˇˇ (|! ° d ONLN dˇˇ )È15 ° d ONLN dˇˇ (à HCustom Item Information ° d ONLN dˇˇ )r ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`................ ° d ONLN dˇˇ (à ∏ ° d ONLN dˇˇ (à
15 ° d ONLN dˇˇ (î 6Custom Remove Interface ° d ONLN dˇˇ )r ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ (î ® ° d ONLN dˇˇ (î
16 ° d ONLN dˇˇ († 6'Selecting the Target Application Folder ° d ONLN dˇˇ )∑ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................... ° d ONLN dˇˇ († Ï ° d ONLN dˇˇ (†
17 ° d ONLN dˇˇ (¨ 6Selecting the System Volume ° d ONLN dˇˇ )Ñ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`................ ° d ONLN dˇˇ (¨ ∫ ° d ONLN dˇˇ (¨
18 ° d ONLN dˇˇ (∏ 6Adding a Splash Screen ° d ONLN dˇˇ )l ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`........................ ° d ONLN dˇˇ (∏ ¢ ° d ONLN dˇˇ (∏
19 ° d ONLN dˇˇ (ƒ 6Providing User Help ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................ ° d ONLN dˇˇ (ƒ î ° d ONLN dˇˇ (ƒ
20 ° d ONLN dˇˇ (– 6 Selecting an Installer Document ° d ONLN dˇˇ )ê ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............ ° d ONLN dˇˇ (– ≈ ° d ONLN dˇˇ (–
20 ° d ONLN dˇˇ (‹ 6Menus ° d ONLN dˇˇ ) ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.................. ° d ONLN dˇˇ (‹ R ° d ONLN dˇˇ (‹
21 ° d ONLN dˇˇ (Ë H
Apple Menu ° d ONLN dˇˇ )9 ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`... ° d ONLN dˇˇ (Ë ° d ONLN dˇˇ (Ë
22 ° d ONLN dˇˇ (Ù H Help Menu ° d ONLN dˇˇ )3 ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`..... ° d ONLN dˇˇ (Ù z ° d ONLN dˇˇ (Ù
22 ° d ONLN dˇˇ ( HApplication Menu ° d ONLN dˇˇ )T ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.......................... ° d ONLN dˇˇ ( ö ° d ONLN dˇˇ (
22 ° d ONLN dˇˇ ( 60Using the Installer Preference Resource (‘inpr’) ° d ONLN dˇˇ )’ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`..................... ° d ONLN dˇˇ ( ° d ONLN dˇˇ (
22 ° d ONLN dˇˇ ( H,Controlling the Recommended Target Selection ° d ONLN dˇˇ )’ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`............... ° d ONLN dˇˇ ( ° d ONLN dˇˇ )Ó23 ° d ONLN dˇˇ ($ HSpecifying Help Pages ° d ONLN dˇˇ )i ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`................... ° d ONLN dˇˇ ($ Ø ° d ONLN dˇˇ ($
23 ° d ONLN dˇˇ (0 H-Allowing Installation onto AppleShare Volumes ° d ONLN dˇˇ )fi ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............ ° d ONLN dˇˇ (0% ° d ONLN dˇˇ )Â24 ° d ONLN dˇˇ (< 6'Installer Preference Resource Reference ° d ONLN dˇˇ )± ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`. ° d ONLN dˇˇ (< Ê ° d ONLN dˇˇ (<
24 ° d ONLN dˇˇ (H HResource Description ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ (H ¶ ° d ONLN dˇˇ (H
24 ° d ONLN dˇˇ (T HData Structures ° d ONLN dˇˇ )H ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` .............................. ° d ONLN dˇˇ (T è ° d ONLN dˇˇ (T
26
° d ONLN dˇˇ (w 6Packages and Atoms " ° ∂ { 4{0 ° ∂ ° ∂
° d ONLN dˇˇ *About Packages (‘inpk’) ° d ONLN dˇˇ )l ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`........................ ° d ONLN dˇˇ (Ö ¢ ° d ONLN dˇˇ (Ö
27 ° d ONLN dˇˇ (ë 6Using Packages ° d ONLN dˇˇ )H ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.... ° d ONLN dˇˇ (ë | ° d ONLN dˇˇ (ë
27 ° d ONLN dˇˇ (ù H Using Packages with Easy Install ° d ONLN dˇˇ )ô ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`... ° d ONLN dˇˇ (ù ‡ ° d ONLN dˇˇ (ù
28 ° d ONLN dˇˇ (¡ 6Package Reference ° d ONLN dˇˇ )T ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ (¡ ä ° d ONLN dˇˇ (¡
28 ° d ONLN dˇˇ (Õ H Package Resource Description ° d ONLN dˇˇ )á ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ......... ° d ONLN dˇˇ (Õ Œ ° d ONLN dˇˇ (Õ
28 ° d ONLN dˇˇ (Ÿ H$Package Comment Resource Description ° d ONLN dˇˇ )¥ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.......................... ° d ONLN dˇˇ (Ÿ ˙ ° d ONLN dˇˇ (Ÿ
30 ˇER d ˇ ˇˇˇˇ d
d , Palatino
. +~-Table of Contents , Helvetica
(Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )¶3
° d ONLN dˇˇ ( Z Z(New Package Comment Resource Description ° d ONLN dˇˇ )à ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............ ° d ONLN dˇˇ ( Z$ ° d ONLN dˇˇ )Ê30 ° d ONLN dˇˇ ( f Z(Old Package Comment Resource Description ° d ONLN dˇˇ )Δ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.............. ° d ONLN dˇˇ ( f ° d ONLN dˇˇ )Í31 ° d ONLN dˇˇ ( r 6About the File Atom ° d ONLN dˇˇ )] ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................. ° d ONLN dˇˇ ( r ì ° d ONLN dˇˇ ( r
32 ° d ONLN dˇˇ ( ~ 6 Using the File Atom (‘infa’) ° d ONLN dˇˇ )Å ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`................. ° d ONLN dˇˇ ( ~ µ ° d ONLN dˇˇ ( ~
32 ° d ONLN dˇˇ ( ä HComparing Files by Version ° d ONLN dˇˇ )~ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............ ° d ONLN dˇˇ ( ä ≈ ° d ONLN dˇˇ ( ä
32 ° d ONLN dˇˇ ( ñ H#Using Split Sources with File Atoms ° d ONLN dˇˇ )• ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................... ° d ONLN dˇˇ ( ñ Ï ° d ONLN dˇˇ ( ñ
33 ° d ONLN dˇˇ ( ¢ H$Using Atom Extenders with File Atoms ° d ONLN dˇˇ )± ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`........................... ° d ONLN dˇˇ ( ¢ ¯ ° d ONLN dˇˇ ( ¢
33 ° d ONLN dˇˇ ( Æ H Installing a Custom Folder Icon ° d ONLN dˇˇ )ç ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`....... ° d ONLN dˇˇ ( Æ ‘ ° d ONLN dˇˇ ( Æ
34 ° d ONLN dˇˇ ( ∫ 6File Atom Reference ° d ONLN dˇˇ )] ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................. ° d ONLN dˇˇ ( ∫ í ° d ONLN dˇˇ ( ∫
34 ° d ONLN dˇˇ ( Δ HResource Description ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ ( Δ ¶ ° d ONLN dˇˇ ( Δ
34 ° d ONLN dˇˇ ( “ 6 About the Resource Atom (‘inra’) ° d ONLN dˇˇ )ñ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`
.......... ° d ONLN dˇˇ ( “ ° d ONLN dˇˇ ( “
38 ° d ONLN dˇˇ ( fi 6Using the Resource Atom ° d ONLN dˇˇ )r ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ ( fi ¶ ° d ONLN dˇˇ ( fi
39 ° d ONLN dˇˇ ( Í HComparing Files By Version ° d ONLN dˇˇ )Å ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ........... ° d ONLN dˇˇ ( Í « ° d ONLN dˇˇ ( Í
39 ° d ONLN dˇˇ ( ˆ H'Using Split Sources with Resource Atoms ° d ONLN dˇˇ )∫ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`........................ ° d ONLN dˇˇ ( ˆ ° d ONLN dˇˇ ( ˆ
39 ° d ONLN dˇˇ ( H(Using Atom Extenders with Resource Atoms ° d ONLN dˇˇ )Δ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.................... ° d ONLN dˇˇ ( ° d ONLN dˇˇ )˛39 ° d ONLN dˇˇ ( 6Resource Atom Reference ° d ONLN dˇˇ )r ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ ( ¶ ° d ONLN dˇˇ (
40 ° d ONLN dˇˇ ( HResource Description ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ ( ¶ ° d ONLN dˇˇ (
40 ° d ONLN dˇˇ (& 6%About the Resource List Atom (‘inr#’) ° d ONLN dˇˇ )® ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.... ° d ONLN dˇˇ (& fi ° d ONLN dˇˇ (&
44 ° d ONLN dˇˇ (2 6 Using the Resource List Atom ° d ONLN dˇˇ )Ñ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`................ ° d ONLN dˇˇ (2 ∫ ° d ONLN dˇˇ (2
44 ° d ONLN dˇˇ (> H-Referencing Resource Atom Lists from Packages ° d ONLN dˇˇ )’ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`............... ° d ONLN dˇˇ (> ° d ONLN dˇˇ )Ó44 ° d ONLN dˇˇ (J 6 Resource List Atom Reference ° d ONLN dˇˇ )Ñ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`................ ° d ONLN dˇˇ (J ∫ ° d ONLN dˇˇ (J
44 ° d ONLN dˇˇ (V HResource Description ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ (V ¶ ° d ONLN dˇˇ (V
45 ° d ONLN dˇˇ (b 6 About the Font Atom (‘inff’) ° d ONLN dˇˇ )Å ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`................. ° d ONLN dˇˇ (b µ ° d ONLN dˇˇ (b
46 ° d ONLN dˇˇ (n 6Using the Font Atom ° d ONLN dˇˇ )] ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................. ° d ONLN dˇˇ (n ì ° d ONLN dˇˇ (n
46 ° d ONLN dˇˇ (z H"Auto-Routing Under Pre-7.1 Systems ° d ONLN dˇˇ )• ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................... ° d ONLN dˇˇ (z Ï ° d ONLN dˇˇ (z
46 ° d ONLN dˇˇ (Ü H$Using Atom Extenders with Font Atoms ° d ONLN dˇˇ )± ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`........................... ° d ONLN dˇˇ (Ü ˘ ° d ONLN dˇˇ (Ü
47 ° d ONLN dˇˇ (í 6Font Atom Reference ° d ONLN dˇˇ )] ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................. ° d ONLN dˇˇ (í ì ° d ONLN dˇˇ (í
47 ° d ONLN dˇˇ (û HResource Description ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ (û ¶ ° d ONLN dˇˇ (û
47 ° d ONLN dˇˇ (™ 6 About the ResMerge Atom (‘inrm’) ° d ONLN dˇˇ )ú ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`........ ° d ONLN dˇˇ (™ — ° d ONLN dˇˇ (™
53 ° d ONLN dˇˇ (∂ 6Using the ResMerge Atom ° d ONLN dˇˇ )u ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`..................... ° d ONLN dˇˇ (∂ ´ ° d ONLN dˇˇ (∂
53 ° d ONLN dˇˇ (¬ 6ResMerge Atom Reference ° d ONLN dˇˇ )u ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`..................... ° d ONLN dˇˇ (¬ ´ ° d ONLN dˇˇ (¬
54 ° d ONLN dˇˇ (Œ 6 About the Folder Atom (‘infm’) ° d ONLN dˇˇ )ç ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`
............. ° d ONLN dˇˇ (Œ √ ° d ONLN dˇˇ (Œ
55 ° d ONLN dˇˇ (⁄ 6Using the Folder Atom ° d ONLN dˇˇ )i ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`......................... ° d ONLN dˇˇ (⁄ ù ° d ONLN dˇˇ (⁄
55 ° d ONLN dˇˇ (Ê H'Specifying the Source and Target Folder ° d ONLN dˇˇ )∑ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`......................... ° d ONLN dˇˇ (Ê ˝ ° d ONLN dˇˇ (Ê
56 ° d ONLN dˇˇ (Ú H$Installing Folders with Custom Icons ° d ONLN dˇˇ )• ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................... ° d ONLN dˇˇ (Ú Ì ° d ONLN dˇˇ (Ú
56 ° d ONLN dˇˇ (˛ H)Creating Empty Folders with a Folder Atom ° d ONLN dˇˇ )… ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`................... ° d ONLN dˇˇ (˛ ° d ONLN dˇˇ )˙56 ° d ONLN dˇˇ (
6Folder Atom Reference ° d ONLN dˇˇ )i ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`......................... ° d ONLN dˇˇ (
ù ° d ONLN dˇˇ (
56 ° d ONLN dˇˇ ( 6Using Action Atoms (‘inaa’) ° d ONLN dˇˇ )~ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.................. ° d ONLN dˇˇ ( ¥ ° d ONLN dˇˇ (
57 ° d ONLN dˇˇ (" 6Action Atom Reference ° d ONLN dˇˇ )i ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`......................... ° d ONLN dˇˇ (" ù ° d ONLN dˇˇ ("
57 ° d ONLN dˇˇ (. HResource Description ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ (. ¶ ° d ONLN dˇˇ (.
58 ° d ONLN dˇˇ (: HData Structures ° d ONLN dˇˇ )H ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` .............................. ° d ONLN dˇˇ (: è ° d ONLN dˇˇ (:
59 ° d ONLN dˇˇ (F ZFunction Interface ° d ONLN dˇˇ )Q ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`..................... ° d ONLN dˇˇ (F ´ ° d ONLN dˇˇ (F
59 ° d ONLN dˇˇ (R ZParameter Block ° d ONLN dˇˇ )N ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ (R ¶ ° d ONLN dˇˇ (R
59 ° d ONLN dˇˇ (^ 6Using Audit Atoms (‘inat’) ° d ONLN dˇˇ ){ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`................... ° d ONLN dˇˇ (^ Ø ° d ONLN dˇˇ (^
61 ° d ONLN dˇˇ (j 6Audit Atom Reference ° d ONLN dˇˇ )f ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.......................... ° d ONLN dˇˇ (j ö ° d ONLN dˇˇ (j
61 ° d ONLN dˇˇ (v HResource Description ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ (v ¶ ° d ONLN dˇˇ (v
61 ° d ONLN dˇˇ (Ç 6 Using Boot Block Atoms (‘inbb’) ° d ONLN dˇˇ )ê ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............ ° d ONLN dˇˇ (Ç ≈ ° d ONLN dˇˇ (Ç
62 ° d ONLN dˇˇ (é 6Boot Block Atom Reference ° d ONLN dˇˇ ){ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`................... ° d ONLN dˇˇ (é ∞ ° d ONLN dˇˇ (é
62 ° d ONLN dˇˇ (ö HResource Description ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ (ö ¶ ° d ONLN dˇˇ (ö
62 ° d ONLN dˇˇ (¶ 6 About Atom Extenders (‘inex’) ° d ONLN dˇˇ )á ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`............... ° d ONLN dˇˇ (¶ Ω ° d ONLN dˇˇ (¶
65 ° d ONLN dˇˇ (≤ 6Writing Atom Extenders ° d ONLN dˇˇ )o ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`....................... ° d ONLN dˇˇ (≤ § ° d ONLN dˇˇ (≤
66 ° d ONLN dˇˇ (æ H"Creating an ‘inex’ Script Resource ° d ONLN dˇˇ )ô ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`... ° d ONLN dˇˇ (æ fl ° d ONLN dˇˇ (æ
66 ° d ONLN dˇˇ ( H Writing a Simple Atom Extender ° d ONLN dˇˇ )ñ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.... ° d ONLN dˇˇ ( › ° d ONLN dˇˇ (
66 ° d ONLN dˇˇ (÷ H'Memory Allocation within Atom Extenders ° d ONLN dˇˇ )√ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`..................... ° d ONLN dˇˇ (÷ ° d ONLN dˇˇ )ˇ69 ˇ>@ d ˇ ˇˇˇˇ d
d , Palatino
. +~-Table of Contents , Helvetica
(Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )¶4
° d ONLN dˇˇ ( Z HRunning within a Sub-Heap ° d ONLN dˇˇ )~ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............ ° d ONLN dˇˇ ( Z Δ ° d ONLN dˇˇ ( Z
69 ° d ONLN dˇˇ ( f H&Converting Existing Decompression Code ° d ONLN dˇˇ )∑ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`......................... ° d ONLN dˇˇ ( f ˇ ° d ONLN dˇˇ ( f
70 ° d ONLN dˇˇ ( r 6Atom Extender Reference ° d ONLN dˇˇ )r ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ ( r ß ° d ONLN dˇˇ ( r
70 ° d ONLN dˇˇ ( ~ HResource Description ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ ( ~ ¶ ° d ONLN dˇˇ ( ~
70 ° d ONLN dˇˇ ( ä HData Structures ° d ONLN dˇˇ )H ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` .............................. ° d ONLN dˇˇ ( ä è ° d ONLN dˇˇ ( ä
72 ° d ONLN dˇˇ ( ñ ZFunction Interface ° d ONLN dˇˇ )Q ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`..................... ° d ONLN dˇˇ ( ñ ´ ° d ONLN dˇˇ ( ñ
72 ° d ONLN dˇˇ ( ¢ ZParameter Block ° d ONLN dˇˇ )N ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ ( ¢ ¶ ° d ONLN dˇˇ ( ¢
72 ° d ONLN dˇˇ ( Æ 6(About Version Compare Functions (‘invc’) ° d ONLN dˇˇ )∫ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` .............................. ° d ONLN dˇˇ ( Æ ° d ONLN dˇˇ ( Æ
76 ° d ONLN dˇˇ ( ∫ H/Using Version Compare Functions with File Atoms ° d ONLN dˇˇ )‰ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`
.......... ° d ONLN dˇˇ ( ∫+ ° d ONLN dˇˇ )fl76 ° d ONLN dˇˇ ( Δ H3Using Version Compare Functions with Resource Atoms ° d ONLN dˇˇ )˘ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`... ° d ONLN dˇˇ ( Δ? ° d ONLN dˇˇ )À77 ° d ONLN dˇˇ ( “ H#Version Compare Runtime Environment ° d ONLN dˇˇ )± ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`........................... ° d ONLN dˇˇ ( “ ˘ ° d ONLN dˇˇ ( “
77 ° d ONLN dˇˇ ( fi 6"Version Compare Function Reference ° d ONLN dˇˇ )• ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`..... ° d ONLN dˇˇ ( fi ⁄ ° d ONLN dˇˇ ( fi
77 ° d ONLN dˇˇ ( Í HFunction Interface ° d ONLN dˇˇ )Q ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`........................... ° d ONLN dˇˇ ( Í ô ° d ONLN dˇˇ ( Í
77 ° d ONLN dˇˇ ( ˆ HParameter Block ° d ONLN dˇˇ )N ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................ ° d ONLN dˇˇ ( ˆ î ° d ONLN dˇˇ ( ˆ
78 ° d ONLN dˇˇ ( HResource Description ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ ( ¶ ° d ONLN dˇˇ (
° d ONLN dˇˇ *Frameworks (‘infr’) ° d ONLN dˇˇ )Z ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` .............................. ° d ONLN dˇˇ (3 è ° d ONLN dˇˇ (3
79 ° d ONLN dˇˇ (? HGlobal Rule Framework ° d ONLN dˇˇ )l ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.................. ° d ONLN dˇˇ (? ¥ ° d ONLN dˇˇ (?
79 ° d ONLN dˇˇ (K HEasy Install Rule Framework ° d ONLN dˇˇ )Ñ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`
.......... ° d ONLN dˇˇ (K à ° d ONLN dˇˇ (K
79 ° d ONLN dˇˇ (W H Custom Install Rule Framework ° d ONLN dˇˇ )ê ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...... ° d ONLN dˇˇ (W ◊ ° d ONLN dˇˇ (W
80 ° d ONLN dˇˇ (c 6Rules (‘inrl’) ° d ONLN dˇˇ )< ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`........ ° d ONLN dˇˇ (c p ° d ONLN dˇˇ (c
80 ° d ONLN dˇˇ (o HUsing Assertions ° d ONLN dˇˇ )K ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................. ° d ONLN dˇˇ (o ì ° d ONLN dˇˇ (o
82 ° d ONLN dˇˇ ({ 6Rule Clause Reference ° d ONLN dˇˇ )f ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.......................... ° d ONLN dˇˇ ({ ö ° d ONLN dˇˇ ({
83 ° d ONLN dˇˇ (á HGlobal Rule Clauses ° d ONLN dˇˇ )] ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`....................... ° d ONLN dˇˇ (á £ ° d ONLN dˇˇ (á
83 ° d ONLN dˇˇ (ì HEasy Install Rule Clauses ° d ONLN dˇˇ )u ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`............... ° d ONLN dˇˇ (ì ª ° d ONLN dˇˇ (ì
91 ° d ONLN dˇˇ (ü HCustom Install Rule Clauses ° d ONLN dˇˇ )~ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............ ° d ONLN dˇˇ (ü Δ ° d ONLN dˇˇ (ü
93 ° d ONLN dˇˇ (‹ 6 Specifying Target Files (‘intf’) ° d ONLN dˇˇ )ç ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`
............. ° d ONLN dˇˇ (‹ ¡ ° d ONLN dˇˇ (‹
93 ° d ONLN dˇˇ (Ë H Installing into Special Folders ° d ONLN dˇˇ )ä ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`........ ° d ONLN dˇˇ (Ë “ ° d ONLN dˇˇ (Ë
93 ° d ONLN dˇˇ (Ù H4Installing into the User-Selected Application Folder ° d ONLN dˇˇ ) ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...... ° d ONLN dˇˇ (Ù7 ° d ONLN dˇˇ )”94 ° d ONLN dˇˇ ( H-Managing Rollbacks on Multiple Target Volumes ° d ONLN dˇˇ )fi ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............ ° d ONLN dˇˇ ( $ ° d ONLN dˇˇ )Ê94 ° d ONLN dˇˇ ( H$Installing onto the Installer Volume ° d ONLN dˇˇ )• ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................... ° d ONLN dˇˇ ( Î ° d ONLN dˇˇ (
95 ° d ONLN dˇˇ ( H"Setting the Finder flags and Dates ° d ONLN dˇˇ )ú ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.. ° d ONLN dˇˇ ( ‰ ° d ONLN dˇˇ (
95 ° d ONLN dˇˇ ($ 6 Specifying Source Files (‘infs’) ° d ONLN dˇˇ )ä ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.............. ° d ONLN dˇˇ ($ ¿ ° d ONLN dˇˇ ($
95 ° d ONLN dˇˇ (0 HSource Disk Search Path ° d ONLN dˇˇ )r ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`................ ° d ONLN dˇˇ (0 ∏ ° d ONLN dˇˇ (0
95 ° d ONLN dˇˇ (< 6File Spec. Reference ° d ONLN dˇˇ )] ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................. ° d ONLN dˇˇ (< ë ° d ONLN dˇˇ (<
96 ° d ONLN dˇˇ (H HResource Descriptions ° d ONLN dˇˇ )c ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`..................... ° d ONLN dˇˇ (H ™ ° d ONLN dˇˇ (H
96 ° d ONLN dˇˇ (T Z#Target File Spec. Resource (‘intf’) ° d ONLN dˇˇ )ô ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................. ° d ONLN dˇˇ (T Ò ° d ONLN dˇˇ (T
96 ° d ONLN dˇˇ (` Z"Source File Spec Resource (‘infs’) ° d ONLN dˇˇ )ì ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................... ° d ONLN dˇˇ (` Ì ° d ONLN dˇˇ (`
98 ° d ONLN dˇˇ (l 6 About File Searching (‘insp’) ° d ONLN dˇˇ )Ñ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`................ ° d ONLN dˇˇ (l π ° d ONLN dˇˇ (l
99 ° d ONLN dˇˇ (x H1Using File Searching with File and Resource Atoms ° d ONLN dˇˇ )Í ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`........ ° d ONLN dˇˇ (x0 ° d ONLN dˇˇ )⁄99 ° d ONLN dˇˇ (Ñ H&Using File Searching with Rule Clauses ° d ONLN dˇˇ )¥ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.......................... ° d ONLN dˇˇ (Ñ ¸ ° d ONLN dˇˇ (Ñ
99 ° d ONLN dˇˇ (ê H3Allowable Installer Functions During File Searching ° d ONLN dˇˇ )Ì ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`....... ° d ONLN dˇˇ (ê5 ° d ONLN dˇˇ )’99 ° d ONLN dˇˇ (ú 6File Searching Reference ° d ONLN dˇˇ )r ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ (ú ß ° d ONLN dˇˇ (ú
100 ° d ONLN dˇˇ (® HData Structures ° d ONLN dˇˇ )H ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` .............................. ° d ONLN dˇˇ (® è ° d ONLN dˇˇ (®
100 ° d ONLN dˇˇ (¥ ZFunction Interface ° d ONLN dˇˇ )Q ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`..................... ° d ONLN dˇˇ (¥ ´ ° d ONLN dˇˇ (¥
100 ° d ONLN dˇˇ (¿ ZParameter Block ° d ONLN dˇˇ )N ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ (¿ ¶ ° d ONLN dˇˇ (¿
100 ° d ONLN dˇˇ (à HResource Description ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ (à ¶ ° d ONLN dˇˇ (Ã
101 ° d ONLN dˇˇ (ÿ 6&About the Disk Order Resource (‘indo’) ° d ONLN dˇˇ )± ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`. ° d ONLN dˇˇ (ÿ  ° d ONLN dˇˇ (ÿ
102 ˇ&ÿ d ˇ ˇˇˇˇ d
d , Palatino
. +~-Table of Contents , Helvetica
(Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )¶5
° d ONLN dˇˇ ( Z 6Disk Order Reference ° d ONLN dˇˇ )c ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`........................... ° d ONLN dˇˇ ( Z ó ° d ONLN dˇˇ ( Z
103 ° d ONLN dˇˇ ( f HResource Description ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ ( f ¶ ° d ONLN dˇˇ ( f
103
° d ONLN dˇˇ ( â 6Installer Functions " ° ∂ ç 4 ç0 ° ∂ ° ∂
° d ONLN dˇˇ *About Installer Functions ° d ONLN dˇˇ )r ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ ( ó ß ° d ONLN dˇˇ ( ó
104 ° d ONLN dˇˇ ( £ ZData I/O Routines ° d ONLN dˇˇ )T ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.................... ° d ONLN dˇˇ ( £ Æ ° d ONLN dˇˇ ( £
104 ° d ONLN dˇˇ ( Ø ZMemory Routines ° d ONLN dˇˇ )N ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ ( Ø ® ° d ONLN dˇˇ ( Ø
108 ° d ONLN dˇˇ ( ª ZMisc. Routines ° d ONLN dˇˇ )B ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.......................... ° d ONLN dˇˇ ( ª õ ° d ONLN dˇˇ ( ª
110
° d ONLN dˇˇ ( fi 6Miscellaneous Features " ° ∂ ‚ 4 ‚0 ° ∂ ° ∂
° d ONLN dˇˇ *About Action Handlers ° d ONLN dˇˇ )i ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`......................... ° d ONLN dˇˇ ( Ï û ° d ONLN dˇˇ ( Ï
113 ° d ONLN dˇˇ ( ¯ HWriting an Action Handler ° d ONLN dˇˇ ){ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`
............. ° d ONLN dˇˇ ( ¯ √ ° d ONLN dˇˇ ( ¯
113 ° d ONLN dˇˇ ( H"Action Handler Runtime Environment ° d ONLN dˇˇ )´ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................. ° d ONLN dˇˇ ( Ú ° d ONLN dˇˇ (
114 ° d ONLN dˇˇ ( 6Action Handler Reference ° d ONLN dˇˇ )u ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`..................... ° d ONLN dˇˇ ( ´ ° d ONLN dˇˇ (
114 ° d ONLN dˇˇ ( HData Structures ° d ONLN dˇˇ )H ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` .............................. ° d ONLN dˇˇ ( è ° d ONLN dˇˇ (
114 ° d ONLN dˇˇ (( ZFunction Interface ° d ONLN dˇˇ )Q ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`..................... ° d ONLN dˇˇ (( ´ ° d ONLN dˇˇ ((
114 ° d ONLN dˇˇ (4 ZParameter Block ° d ONLN dˇˇ )N ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ (4 ¶ ° d ONLN dˇˇ (4
114 ° d ONLN dˇˇ (@ ZActions ° d ONLN dˇˇ )$ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.... ° d ONLN dˇˇ (@ | ° d ONLN dˇˇ (@
115 ° d ONLN dˇˇ (L HResource Description ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ (L ¶ ° d ONLN dˇˇ (L
117 ° d ONLN dˇˇ (X 6-About the Installer Version Resource (‘invs’) ° d ONLN dˇˇ )… ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`......................... ° d ONLN dˇˇ (X ˛ ° d ONLN dˇˇ (X
118 ° d ONLN dˇˇ (d 6Installer Version Reference ° d ONLN dˇˇ ){ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`................... ° d ONLN dˇˇ (d ± ° d ONLN dˇˇ (d
119 ° d ONLN dˇˇ (p HResource Description ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ (p ¶ ° d ONLN dˇˇ (p
119 ° d ONLN dˇˇ (| 6'About the Script Size Resource (‘insz’) ° d ONLN dˇˇ )Æ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.. ° d ONLN dˇˇ (| ‚ ° d ONLN dˇˇ (|
119 ° d ONLN dˇˇ (à 6Script Size Reference ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ............................ ° d ONLN dˇˇ (à ñ ° d ONLN dˇˇ (à
119 ° d ONLN dˇˇ (î HResource Description ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ (î ¶ ° d ONLN dˇˇ (î
119 ° d ONLN dˇˇ († 60About the Script Creation Date Resource (‘incd’) ° d ONLN dˇˇ )€ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`................... ° d ONLN dˇˇ († ° d ONLN dˇˇ )˙120 ° d ONLN dˇˇ (¨ 6 Script Creation Date Reference ° d ONLN dˇˇ )ç ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`
............. ° d ONLN dˇˇ (¨ √ ° d ONLN dˇˇ (¨
120 ° d ONLN dˇˇ (∏ HResource Description ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`...................... ° d ONLN dˇˇ (∏ ¶ ° d ONLN dˇˇ (∏
° d ONLN dˇˇ *Installing Desk Accessories ° d ONLN dˇˇ ){ ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`................... ° d ONLN dˇˇ (È ± ° d ONLN dˇˇ (È
121 ° d ONLN dˇˇ (ı H Installing into Pre-7.X Systems ° d ONLN dˇˇ )ç ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`....... ° d ONLN dˇˇ (ı ‘ ° d ONLN dˇˇ (ı
121 ° d ONLN dˇˇ ( HInstalling into System 7.X ° d ONLN dˇˇ )u ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`............... ° d ONLN dˇˇ ( Ω ° d ONLN dˇˇ (
122
° d ONLN dˇˇ ($ 6Glossary " ° ∂ ( 4(0 ° ∂ ° ∂
° d ONLN dˇˇ *Glossary ° d ONLN dˇˇ )* ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )` ................................ ° d ONLN dˇˇ )`.............. ° d ONLN dˇˇ (2 ^ ° d ONLN dˇˇ (2
123 ˇ
˙ d ˇ ˇˇˇˇ d
d , Palatino
. +~-C H A P T E R 1 , Helvetica
(Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )¶6
$ ° d ONLN d Q ~ y≥ ( o ~Scripting Overview " ° ∂ 40 ° ∂ ° ∂
° d ONLN dà ~*ô *∏?This chapter provides an overview of writing Installer scripts.
° d ONLN d B 6V — (Q 6Scripting Overview " ° ∂ V 4V0 ° ∂ ° ∂
° d ONLN d [ ~g+ +HhAn Installer script is a list of instructions for the Installer, in the form of resources. These script ° d ONLN dàg ~s# * bresources tell the Installer how to perform an Installation. An Installer script is written using ° d ONLN dÎs ~ * Rthe MPW (Macintosh Programmer's Workshop) Rez language, and compiled using the MPW ° d ONLN d> ~ã' * ^Rez tool. It is expected that Installer scriptwriters are familiar with the Rez language, MPW ° d ONLN dùã ~óH * )development system, and the MPW Rez tool. ° d ONLN d«ü ~´! *`The script resources can be divided into three main groups: script resources for displaying the ° d ONLN d(´ ~∑ * ]interface, script resources for describing what actions to perform during the installation or ° d ONLN dÜ∑ ~√= * *removal, and independent script resources.
° d ONLN d±◊ ~Êì *"-Script Resources for Displaying the Interface " ° ∂  |Â0 ° ∂ ° ∂
° d ONLN dflÍ ~ˆ, *`The scriptwriter is responsible for providing a recommended software selection for Easy Install, ° d ONLN d@ˆ ~ * Yand an optional list of software choices for Custom Install. Each interface requires the ° d ONLN dö ~, * cscriptwriter to create instructions (Installer rules) that are evaluated to tell the Installer what ° d ONLN d˛ ~Á * Oto display to the user and what will happen during the installation or removal. ° d ONLN dP" ~. *aIt is useful to think of script resources as working in a hierarchy. At the top of the hierarchy ° d ONLN d≤. ~: « * are framework ( ,
Courier ° d ONLN d¡. «: Î )I‘infr’ ° d ONLN d«. Î: )$ ) and rule ( ° d ONLN d”. :@ )1‘inrl’ ° d ONLN dŸ.@:& )$7) script resources. The Installer uses these resources ° d ONLN d: ~F (C ~Xto examine the environment and make decisions about what to install based on what it has ° d ONLN djF ~R( * `found on the user’s target disk. For example, in System Software, we install different software ° d ONLN dÀR ~^ * ^depending on the type of machine the Installer is running on, the type of target disk the user ° d ONLN d *^ ~j * \has chosen, and what has previously been installed. To use these features, the scriptwriter ° d ONLN d áj ~v∂ * Hmust provide a set of if-then rules to reach the goal of each interface. ° d ONLN d –~ ~ä ˝ * Easy Install interface goals: ,
Zapf Dingbats
° d ONLN d Óî ~ù Ö *n
° d ONLN d í êû" )VCreate the recommended software message that will be shown in the Easy Install dialog. ° d ONLN d Hû ê™- * \This translates into including the proper rule clauses that will display the desired message ° d ONLN d •™ ê∂ » * or error text.
° d ONLN d ¥¿ ~… Ö (« ~n
° d ONLN d ∂æ ê , )`Tell the Installer what actions to take after the user clicks the Install button. This requires ° d ONLN d ê÷— * Ithe scriptwriter to add to the list of packages that should be installed. ˇÕ¥ d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ] ( Z ~ Custom Install interface goals: ,
Zapf Dingbats
° d ONLN d g ~ p Ö *n
° d ONLN d " e ê q$ )ZSpecify the software components to be listed in the Custom Install dialog. Each top-level ° d ONLN d } q ê } * Witem equates to a package, with possible sub-packages, that the scriptwriter explicitly ° d ONLN d ’ } ê â ÿ * adds to the list. ° d dPro † Ç † å † † ° § P ]
"ID #˛˚ # #ˇ˚ # # # # # # # # # #ˇ # #ˇ # Ñ
í í † £
ë ~{ Å 4?AGF?AFˇAABˇBEFˇDBCˇGCEˇˇ † ° † † ° § P
# #˝ˆ # # # # # #ˇ # #ˇ # ] Ñ
í í † £
ë ~{ Å 4?AFF?AFˇ@ABˇBEFˇCBCˇFCEˇˇ #˝ˆ # # #ˇ #ˇ # † ° † † ° § P
"HC #˝ˆ # # # # # #ˇ # #ˇ # † £
ë ~{ #˝ˆ # # #ˇ #ˇ # † ° "$C † ç † å † † ° § P ]
"ID #˙ˇ # #˚ˇ # # ˛ # #ˇ # #ˇ # #ˇ # # # # # Ñ
í í † £
ë ~{ Å `B9IDB<=ˇC;<=>ˇD:;>?ˇE9:?AˇFABˇG9<BCˇH<ACDˇIADˇˇ † ° † † ° § P
# #ı˛ # #˝ # #˛ # # # # # ] Ñ
í í † £
ë ~{ Å `B9IDB<=ˇC;<=>ˇD:;>?ˇE?@ˇF9:@AˇG9<ABˇH<ABDˇIADˇˇ #ı˛ #˝ #˛ # # # † ° † † ° § P
ˇˇ ˇˇ ˇˇ ˇˇÓ ˇ ˛ˇ⁄ ˇˇ N ˇı ˇÅ ‹ ˇˇ¢ ˇˇ ˇ« ˛ˇ ˇÓ ˇˇ˛ ˇˇ ˇˇ˛ ˛ˇ¸ ˇˇ˛ ¸ˇ ˇˇ ˇˇÓ ˇ ˛ˇ⁄ ˇˇ ˇÅ Õ ¢ˇ≥ ˛ˇ ˇ≥ ˇ ˛ˇ⁄ ˇˇ˚ " ˇı ˇÅ Å Ë ˇ« ˛ˇ ˇ≥ ˇ ˛ˇ⁄ ˇˇ¸ ˇÅ Å † ˛ˇ ˇ≥ ˇ ˛ˇ⁄ ˇˇ $ ˇı ˇÅ Å Ë ˇ« ˛ˇ ˇµ ˇ ˛ˇ⁄ ˇˇ ˇÅ Å † ˝ˇ ˇˇ∑ ˇˇ ˝ˇ⁄ ˇˇU ˇı ˇÅ Å Ë ˇΔ ˛ˇ˛ ∑ˇ˛ ˛ˇŸ ˇˇ ˇÅ Å ü ¸ˇµ ¸ˇŸ ˇˇU ˇı ˇÅ Å Ë ˇ≈ ≠ˇÿ ˇˇ ˇÅ Å ù Øˇ◊ ˇˇU, ˇı ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ ˇ¬ ≥ˇ’ ˇˇ¸ ˇÅ Å Å ° ˇˇ ˇÅ Å Å ° ˇˇU ˇÅ Å Å ° ˇˇ ˇÅ Å Å ° ˇˇU ˇÅ Å Å ° ˇˇU ˇÅ Å Å ° ˇˇU ˇÅ Å Å ° ˇˇù ˇÅ Å Å ° ˇˇ¸ ˇÅ Å Å ° ˇˇ ˇÅ Å Å ° ˇˇ˝ ˇÅ Å Å ° ˇˇU ˇÅ Å Å ° ˇˇ
ÅˇÅˇÅˇûˇ ÅˇÅˇÅˇüˇ U † É
d
. ° d ONLN d Áè ~ût (ö ~'Script Resources for Describing Actions " ° ∂ ù |ù0 ° ∂ ° ∂
° d ONLN d¢ ~Æ# *aInstaller rules specify the actions to be performed by selecting a set of packages (resource type ,
Courier ° d ONLN dqÆ ~∫ ¢ * 'inpk' ° d ONLN dwÆ ¢∫- )$X). Packages have names, associated comment resources, and a list that references atoms. ° d ONLN d—∫ ~Δ( (√ ~aAtoms are script resources that describe a specific action to be performed during an installation ° d ONLN d3Δ ~“a * 5or removal, such as copy a file or delete a resource. ° d ONLN di⁄ ~Ê *TIn addition to atoms, packages may also reference other packages called subpackages. ° d ONLN døÊ ~ÚÙ * PSubpackages are identical to packages and have two main purposes: to provide the ° d ONLN dÚ ~˛ˆ * Shierarchical list shown in the Custom Install dialog and to make scripting simpler. ° d ONLN dd ~$ *aIn the hierarchy of Installer script resources, atoms are at the lowest level. Atoms come in six ° d ONLN dΔ ~ * Vflavors: File Atoms, Resource Atoms, Font Atoms, ResMerge Atoms, Folder Atoms, Action ° d ONLN d ~*Ü * 8Atoms, Audit Atoms and Boot Block Atoms (resource types ° d ONLN dU Ü*™ ('Ü'infa' ° d ONLN d[ ™*Ø )$, ° d ONLN d] Ø*” )'inra' ° d ONLN dc ”*ÿ )$, ° d ONLN de ÿ* )'inff’, ° d ONLN dm* ~6 ¢ (3 ~‘inrm' ° d ONLN ds* ¢6 ß )$, ° d ONLN du* ß6 À )‘infm' ° d ONLN d{* À6 – )$, ° d ONLN d}* –6 Ù )'inaa' ° d ONLN dÉ* Ù6 ˘ )$, ° d ONLN dÖ* ˘6 )'inat' ° d ONLN dã* 65 )$, and ° d ONLN dë*56Y )'inbb' ° d ONLN dó*Y6 )$), respectively). Note that atoms are not ° d ONLN d¡6 ~B
(? ~Yvisible to the user of the Installer program. All atoms are contained within packages or ° d ONLN dB ~N π * subpackages. ˇ#ƒ d ˇ ˇˇˇˇ d
. ° d ONLN d A ~P< (L ~ Independent Script Resources " ° ∂ O |O0 ° ∂ ° ∂
° d ONLN d T ~`. *aSeven independent script resources can optionally be added to the script to control miscellaneous ° d ONLN d Ä` ~l# * &Installer actions and interface parts. ˇ5ˆ d ˇ ˇˇˇˇ d
Q ~ ‰˚ Ä 1 ` Ä Å ˆ ˇˇˇˇˇˇˇˇ 8 ˇˇˇˇˇˇ 1 S Ä b ˆ ˇˇˇˇˇˇˇˇ 8 † õ ° ñ † ò ° d dPro $
T à a ÿ , Times . ˇ ì} ì} ц ° d ONLN d V ã _ ê ( ] ãS Ü ° d ONLN dˇˇ )c ц ° d ONLN dˇˇ )r ɇ ° d ONLN dˇˇ )i ° d ONLN dˇˇ )p Ñ ° d ONLN dˇˇ )t ° d ONLN dˇˇ ) D ° d ONLN dˇˇ )C D‡ ° d ONLN dˇˇ )r D ° d ONLN dˇˇ )e B¿ ° d ONLN dˇˇ )a A` ° d ONLN dˇˇ )t ¡Ä ° d ONLN dˇˇ )i A† ° d ONLN dˇˇ )o ¡† ° d ONLN dˇˇ )n A† ° d ONLN dˇˇ ) ņ ° d ONLN dˇˇ )D Ä ° d ONLN dˇˇ )a ° d ONLN dˇˇ )t Ä@ ° d ONLN dˇˇ )e † ô † ó † ú
Q ~ ‰˚ 1 S Ä b ä 8 † õ ° ñ † ò ° d dPro $
d Å q õ ° d ONLN dˇˇ ( m Ñ' 7‡ ° d ONLN dˇˇ )i 7¿ ° d ONLN dˇˇ )n 9 ° d ONLN dˇˇ )c π ° d ONLN dˇˇ )d ∫Ä ° d ONLN dˇˇ )' † ô † ó † ú
Q ~ ‰˚ Ä 1 í Ä ≥ ˆ ˇˇˇˇˇˇˇˇ 8 ˇˇˇˇˇˇ 1 Ñ Ä ì ˆ ˇˇˇˇˇˇˇˇ 8 † õ ° ñ † ò ° d dPro $
Ü à ì ∂ ц ° d ONLN dˇˇ ( è ãD Ä ° d ONLN dˇˇ )i ц ° d ONLN dˇˇ )s @ ° d ONLN dˇˇ )k Ö@ ° d ONLN dˇˇ ) ≈@ ° d ONLN dˇˇ )O E ° d ONLN dˇˇ )r D` ° d ONLN dˇˇ )d ƒ` ° d ONLN dˇˇ )e √ ° d ONLN dˇˇ )r † ô † ó † ú
Q ~ ‰˚ 1 Ñ Ä ì ä 8 † õ ° ñ † ò ° d dPro $
ï Å ¢ õ ° d ONLN dˇˇ ( û Ñ' 7‡ ° d ONLN dˇˇ )i 7¿ ° d ONLN dˇˇ )n 9 ° d ONLN dˇˇ )d :Ä ° d ONLN dˇˇ )o ;‡ ° d ONLN dˇˇ )' † ô † ó † ú
Q ~ ‰˚ Ä 1 í ≥x ˇˇˇˇˇˇˇˇ 8 ˇˇˇˇˇˇ 1 Ñ ìx ˇˇˇˇˇˇˇˇ 8 † õ ° ñ † ò ° d dPro $
Ü ì8 † ° d ONLN dˇˇ ( èS ° d ONLN dˇˇ )c † ° d ONLN dˇˇ )r ‡ ° d ONLN dˇˇ )i Ñ ° d ONLN dˇˇ )p ° d ONLN dˇˇ )t Ñ ° d ONLN dˇˇ ) ƒ ° d ONLN dˇˇ )S ≈Ä ° d ONLN dˇˇ )i E† ° d ONLN dˇˇ )z D@ ° d ONLN dˇˇ )e † ô † ó † ú
Q ~ ‰˚ 1 Ñ ì 8 † õ ° ñ † ò ° d dPro $
ï ¢ ° d ONLN dˇˇ ( û' ∑‡ ° d ONLN dˇˇ )i ∑¿ ° d ONLN dˇˇ )n π ° d ONLN dˇˇ )s 9 ° d ONLN dˇˇ )z π ° d ONLN dˇˇ )' † ô † ó † ú † õ ° ñ † ò ° d dPro 0
† ° d ONLN dˇˇ +T2S ° d ONLN dˇˇ )c † ° d ONLN dˇˇ )r ‡ ° d ONLN dˇˇ )i Ñ ° d ONLN dˇˇ )p ° d ONLN dˇˇ )t Ñ ° d ONLN dˇˇ ) õ ° d ONLN dˇˇ )V ê ° d ONLN dˇˇ )e 0 ° d ONLN dˇˇ )r p ° d ONLN dˇˇ )s ö ° d ONLN dˇˇ )i 0 ° d ONLN dˇˇ )o ö0 ° d ONLN dˇˇ )n † ô † ó † ú
Q ~ ‰˚ 1 ∂ ≈ 8 † õ ° ñ † ò ° d dPro $
« ‘ ° d ONLN dˇˇ ( –' ∑‡ ° d ONLN dˇˇ )i ∑¿ ° d ONLN dˇˇ )n π ° d ONLN dˇˇ )v 9 ° d ONLN dˇˇ )s π ° d ONLN dˇˇ )' † ô † ó † ú
Q ~ ‰˚ Ä 1 ` Åx ˇˇˇˇˇˇˇˇ 8 ˇˇˇˇˇˇ 1 S bx ˇˇˇˇˇˇˇˇ 8 † õ ° ñ † ò ° d dPro $
T aC † ° d ONLN dˇˇ ( ]S ° d ONLN dˇˇ )p Ü ° d ONLN dˇˇ )l ° d ONLN dˇˇ )a ¿ ° d ONLN dˇˇ )s Ö` ° d ONLN dˇˇ )h ` ° d ONLN dˇˇ ) E` ° d ONLN dˇˇ )S F¿ ° d ONLN dˇˇ )c E` ° d ONLN dˇˇ )r D† ° d ONLN dˇˇ )e C@ ° d ONLN dˇˇ )e A‡ ° d ONLN dˇˇ )n † ô † ó † ú
Q ~ ‰˚ 1 S b 8 † õ ° ñ † ò ° d dPro $
d {o ° d ONLN dˇˇ ( m' ∑‡ ° d ONLN dˇˇ )P ∏† ° d ONLN dˇˇ )I 8¿ ° d ONLN dˇˇ )C ∏† ° d ONLN dˇˇ )T 8 ° d ONLN dˇˇ )' Ô‡ ° d ONLN dˇˇ ) p ° d ONLN dˇˇ )" °‡ ° d ONLN dˇˇ )S ¢† ° d ONLN dˇˇ )p § ° d ONLN dˇˇ )l £‡ ° d ONLN dˇˇ )a •@ ° d ONLN dˇˇ )s %@ ° d ONLN dˇˇ )h &† ° d ONLN dˇˇ ) ¶¿ ° d ONLN dˇˇ )S ßÄ ° d ONLN dˇˇ )c 'Ä ° d ONLN dˇˇ )r &¿ ° d ONLN dˇˇ )e ( ° d ONLN dˇˇ )e )Ä ° d ONLN dˇˇ )n *‡ ° d ONLN dˇˇ )" \¿ ° d ONLN dˇˇ ) ‹‡ ° d ONLN dˇˇ )o fi@ ° d ONLN dˇˇ )r ›Ä )
† ô † ò ° d dPro $ ° d ONLN dˇˇ ( w" 1‡ ° d ONLN dˇˇ )C ±¿ ° d ONLN dˇˇ )o ≥ ° d ONLN dˇˇ )l ≥ ° d ONLN dˇˇ )o ¥` ° d ONLN dˇˇ )r ≥† ° d ONLN dˇˇ ) 3¿ ° d ONLN dˇˇ )S 4Ä ° d ONLN dˇˇ )p 5‡ ° d ONLN dˇˇ )l 5¿ ° d ONLN dˇˇ )a 7 ° d ONLN dˇˇ )s ∑ ° d ONLN dˇˇ )h ∏Ä ° d ONLN dˇˇ ) 8† ° d ONLN dˇˇ )S 9` ° d ONLN dˇˇ )c π` ° d ONLN dˇˇ )r ∏† ° d ONLN dˇˇ )e ∫ ° d ONLN dˇˇ )e ª` ° d ONLN dˇˇ )n º¿ ° d ONLN dˇˇ )" † ô † ó † ú
Üç ìÀ ц ° d ONLN dˇˇ +4A Ä ° d ONLN dˇˇ )c ° d ONLN dˇˇ )t É@ ° d ONLN dˇˇ )i ` ° d ONLN dˇˇ )o É` ° d ONLN dˇˇ )n ` ° d ONLN dˇˇ ) C` ° d ONLN dˇˇ )H √@ ° d ONLN dˇˇ )a ¡‡ ° d ONLN dˇˇ )n A‡ ° d ONLN dˇˇ )d ¡‡ ° d ONLN dˇˇ )l B ° d ONLN dˇˇ )e @† ° d ONLN dˇˇ )r † ô † ó † ú
Q ~ ‰˚ 1 ÑÖ ìè 8 † õ ° ñ † ò ° d dPro $
ïÜ ¢† ° d ONLN dˇˇ ( ûâ' 7‡ ° d ONLN dˇˇ )i 7¿ ° d ONLN dˇˇ )n 9 ° d ONLN dˇˇ )a :Ä ° d ONLN dˇˇ )h ;‡ ° d ONLN dˇˇ )' † ô † ó † ú
Q ~ ‰˚ Ä 1 `Ö Å˚ ˇˇˇˇˇˇˇˇ 8 ˇˇˇˇˇˇ 1 SÖ b˚ ˇˇˇˇˇˇˇˇ 8 † õ ° ñ † ò ° d dPro $
Tç aΩ Ñ† ° d ONLN dˇˇ ( ]êP Ü ° d ONLN dˇˇ )r Ö@ ° d ONLN dˇˇ )e ɇ ° d ONLN dˇˇ )f É ° d ONLN dˇˇ )e Å¿ ° d ONLN dˇˇ )r Å ° d ONLN dˇˇ )e † ° d ONLN dˇˇ )n ˇ† ° d ONLN dˇˇ )c ˛@ ° d ONLN dˇˇ )e ¸‡ ° d ONLN dˇˇ )s † ô † ó † ú
Q ~ ‰˚ 1 SÖ bè 8 † õ ° ñ † ò ° d dPro $
dÜ qû ° d ONLN dˇˇ ( mâ' 7‡ ° d ONLN dˇˇ )i 7¿ ° d ONLN dˇˇ )n 9 ° d ONLN dˇˇ )p :Ä ° d ONLN dˇˇ )r 9¿ ° d ONLN dˇˇ )' † ô † ó † ú ˇˇˇˇˇˇ
Q ~ ‰˚ 1 nõ }ˆ ˇˇˇˇˇˇˇˇ 8 † õ ° ñ † ò ° d dPro $
o§ |˘ † ° d ONLN dˇˇ +
C ` ° d ONLN dˇˇ )o Ö` ° d ONLN dˇˇ )d ` ° d ONLN dˇˇ )e ° d ONLN dˇˇ ) D ° d ONLN dˇˇ )R D¿ ° d ONLN dˇˇ )e C` ° d ONLN dˇˇ )s ƒ ° d ONLN dˇˇ )o D ° d ONLN dˇˇ )u ƒ ° d ONLN dˇˇ )r √@ ° d ONLN dˇˇ )c ¡‡ ° d ONLN dˇˇ )e † ô † ó † ú
° d ONLN d ~!! +H\Many activities occur during an installation or removal. Keeping the order and dependencies ° d ONLN d q! ~- * Zstraight is a challenge. To help you understand the specific events that happen during an ° d ONLN d Ã- ~9q * 4installation, the seven phases are summarized below.
° d ONLN dM, ô8) + Begin execution of Global Rules, ° d ONLN dn8 ôD * then the rules for the current ° d ONLN dçD ôP * interface mode (Easy or ° d ONLN d•P ô\ ¡ * Custom). ° d WORD ø
,2@Ò 4.48 8
d ™U™U™U™U "(- 3 "(- 3 ° d dPro † Ç
` ~o è ê » [ ‚ É » ` ‚ }a n é è•ÒÄ ˇ¿Ä û<yÄ ‡ 0@ n øÄ o` _ Øà (◊Ñ PØÇ QW¬ °Ø¡ °W¡ !Ø¿Ä !ˇÄ ?U^Ä Í™´Ä }U^ ˇ † É
d ° d ONLN d±` ôl * Call code resources referenced ° d ONLN d–l ôx * by CheckUserFunction and ° d ONLN dÈx ôÑ' * CheckRuleFunction rule clauses ° d ONLN dÑ ôê# * when, and if, the rule clause is ° d ONLN d)ê ôú À *
d ° d ONLN d • ≤ ô æ * If the Atom Extender did not ° d ONLN d ¬ æ ô * read the data, the Installer ° d ONLN d fl ô ÷& * reads as much data as possible, ° d ONLN d ˇ ÷ ô ‚ * placing each chunk into the ° d ONLN d ‚ ô Ó * buffer list. If not enough ° d ONLN d7 Ó ô ˙ * memory is free to buffer the ° d ONLN dT ˙ ô" * data, the buffer list is flushed ° d ONLN du ô& * and the data is written to disk. ° d dPro † Ç
é è•ÒÄ ˇ¿Ä û<yÄ ‡ 0@ n øÄ o` _ Øà (◊Ñ PØÇ QW¬ °Ø¡ °W¡ !Ø¿Ä !ˇÄ ?U^Ä Í™´Ä }U^ ˇ † É
d
° d ONLN dˇ ô +Send ‘Success’ or ‘Cancel ‘ ° d ONLN d ô$ * message to Atom Extenders. ° d dPro † Ç
2: 14: 8 † É ° d dPro † Ç
:B 1<B 8 † É ° d dPro † Ç
BJ 1DJ 8 † É ° d dPro † Ç
JR 1LR 8 † É ° d dPro † Ç
RZ 1TZ 8 † É
d ™U™U™U™U "- "- ° d dPro † Ç
( ~7 è ê » [ ‚ É » ` ‚ }) 6 é è•ÒÄ ˇ¿Ä û<yÄ ‡ 0@ n øÄ o` _ Øà (◊Ñ PØÇ QW¬ °Ø¡ °W¡ !Ø¿Ä !ˇÄ ?U^Ä Í™´Ä }U^ ˇ † É
d ° d ONLN d9( ô4& * Send ‘after’ or ‘cleanUpCancel’ ° d ONLN dY4 ô@* * message to ‘after’ Action Atoms. ° d dPro † Ç
*z6Ç ˇˇˇˇˇˇˇˇ 1,|6Ç 8 † É ° d dPro † Ç
*Ç6ä 1,Ñ6ä 8 † É ° d dPro † Ç
*ä6í 1,å6í 8 † É ° d dPro † Ç
*í6ö 1,î6ö 8 † É ° d dPro † Ç
*ö6¢ 1,ú6¢ 8 † É
d ™U™U™U™U "$- "$- ° d dPro † Ç
D ~V ç ê z ú ö º z £ ö ºE U å ˇ¸ Ä Ò a a a ! D < Ä ˇ † É
d ° d ONLN dÅD ôP *Successful or error dialog ° d ONLN dúP ô\! * appears. If the user clicks the ° d ONLN dΩ\ ôh * Continue button then the ° d ONLN d÷h ôt * Installer continues with the ° d ONLN dÛt ôÄ * next step then begins again ° d ONLN dÄ ôå ˆ * with Rule execution. ° d dPro † Ç
$ ° d ONLN d Q ~ y ( o ~Installer Human Interface " ° ∂ 40 ° ∂ ° ∂
° d ONLN d ~*¨ *∏DThis chapter describes the human interface aspects of Installer 4.0.
° d ONLN d _B 6V ‰ (Q 6Easy Install Interface " ° ∂ V 4V0 ° ∂ ° ∂
° d ONLN d v[ ~g +H[The Easy Install interface now allows user selection of the target application folder and a ° d ONLN d “g ~s! * blarger message area. The target selection area is different for scripts requiring selection of an ° d ONLN d5s ~d * 5application folder versus selection of a target disk.
° d ONLN dká ~í ∞ *
Figure 2-1 ° d ONLN dvá Ωí )?The Easy Install dialog. † Ç † é
° d ONLN d Q ~ `? ( \ ~ Using the Target Disk Interface " ° ∂ _ | _0 ° ∂ ° ∂
° d ONLN d d ~ p$ *aIf your product must always be installed into a specific location on the target disk, then you’ll ° d ONLN d Ç p ~ |* * aprobably want to limit the user to only selecting from the mounted volumes. This is the case for ° d ONLN d ‰ | ~ à * Xproducts, such as system software, that need to be installed predominately in the System ° d ONLN d= à ~ î ÿ * Folder. Setting the ,
Courier ° d ONLN dR à ÿ î> )ZuseDiskTargetMode ° d ONLN dc à> î% )f7 flag in the preference resource tells the Installer to ° d ONLN dõ î ~ †Ü ( ù ~;present an interface compatible with the old Installer 3.X. ° d ONLN d◊ ® ~ ¥ *ZClicking Switch Disk cycles through the mounted volumes. Clicking Eject Disk will eject a ° d ONLN d2 ¥ ~ ¿ fl * chosen ejectable disk.
° d ONLN dI ‘ ~ „h *"&Using the Application Folder Interface " ° ∂ ‚ | ‚0 ° ∂ ° ∂
° d ONLN dp Á ~ Û! *]If your script installs a product such as an application which can be placed most anywhere on ° d ONLN dŒ Û ~ ˇ * \the user's Macintosh, then you’ll probably want to allow the user to select a target folder. ° d ONLN d, ˇ ~ ≥ * Setting the ° d ONLN d8 ˇ ≥ % )5useFolderTargetMode ° d ONLN dK ˇ% )r7 flag in the preference resource tells the Installer to ° d ONLN dÉ ~ ( ~]present an interface to the user for selecting the target folder in both the Easy Install and ° d ONLN d· ~#ë * ?Custom Install dialogs. This interface is shown in Figure 2-2. ° d ONLN d!+ ~7 · *Much like the current ° d ONLN d7+ ·7) )c special-xxxx ° d ONLN dC+)7∫ )H! folder path identifier, the new ° d ONLN dd+∫7¸ )ë folder-user ° d ONLN do+¸7 )B folder ° d ONLN dw7 ~C (@ ~^path identifier will be the folder path selected by the user. When the user clicks the Select ° d ONLN d÷C ~O * ]Folder button a modified standard file dialog appears to allow selection of a new or existing ° d ONLN d4O ~[ * Rfolder. This dialog is discussed in the section “Using the Select Folder Dialog”.
° d ONLN dác ~n ∞ *
Figure 2-2 ° d ONLN díc Ωn| )?2The interface for selecting an application folder. † Ç
° d ONLN d≈÷ ~‚ (fl ~SThe icon and name for the selected folder depends on the folder chosen by the user: ,
Zapf Dingbats
° d ONLN dÏ ~ı Ö *n
° d ONLN dÍ êˆ( )_If a folder is selected, the folder’s icon will appear with the folder's name on the first line ° d ONLN d{ˆ êÇ * 4and “on the disk “Macintosh HD”” on the second line.
° d ONLN d≤ ~ Ö ( ~n
° d ONLN d¥
ê˚ )RIf the root level of a volume is selected, the volume’s icon and name will appear. ° d ONLN d ~*# (' ~]A default target folder is always recommended to the user when first launching the Installer. ° d ONLN df* ~6 * [The scriptwriter can optionally override the Installer’s suggested default folder using the ° d ONLN d¬6 ~B ÷ * preference resource.
° d ONLN d◊V ~e Æ *"Buttons " ° ∂ d |d0 ° ∂ ° ∂
° d ONLN dfli ~u Ú *Buttons and their actions:
° d ONLN d˙ ~à Ö *n
° d ONLN d¸} êâ )XInstall (or Remove) — Starts the installation or removal. The button is enabled in Easy ° d ONLN dUâ êï * XInstall if there was not an error preventing the installation from beginning. In Custom ° d ONLN dÆï ê°, * \Install and Custom Remove, the button is enabled only if one or more items are selected from ° d ONLN d ° ê≠ µ * the list.
° d ONLN d ∑ ~¿ Ö (æ ~n
° d ONLN d µ ê¡C )'Quit — Quits the Installer application. ˇ%ò d ˇ ˇˇˇˇ d
° d ONLN d Q ê ]* )XHelp — Opens a the Help dialog. The Help dialog is explained in section “Providing User ° d ONLN d [ ] ê i ∞ * Help”.
° d ONLN d b s ~ | Ö ( z ~n
° d ONLN d d q ê } )WSwitch Disk — Changes the currently selected target disk to the next disk in the volume ° d ONLN d º } ê â+ * _list. If no other volumes are available to choose from, this button is dimmed. This button is ° d ONLN d â ê ïÖ * 5only shown when using the target disk interface mode.
° d ONLN d … ê ’+ )\Select Folder — Opens the folder selection dialog. The folder selection dialog is explained ° d ONLN dr ’ ê ·$ * [in section “Selecting the Target Application Folder”. If the scriptwriter has enabled this ° d ONLN dŒ · ê Ì * Wfeature, and the Option Key is down, the button text changes to “System Disk” and opens ° d ONLN d& Ì ê ˘ * Wthe system volume selection dialog. The system volume selection dialog is explained in ° d ONLN d~ ˘ ê * Rsection “Selecting the System Volume”. This button is only visible when using the ° d ONLN d— ê, * "application folder interface mode.
B ~N$ +H]The Custom Install dialog can provide experienced users with the flexibility needed to create ° d ONLN dkN ~Z5 * )customized installations of your product.
° d ONLN dïb ~m ∞ *
Figure 2-3 ° d ONLN d†b Ωm" )?The Custom Install dialog † Ç † é
° d ONLN d∫≠ ~º (∏ ~Custom Install List " ° ∂ ª |ª0 ° ∂ ° ∂
° d ONLN dŒ¿ ~Ã
*VHierarchical custom items allow many opportunities to provide specific choices without ° d ONLN d%à ~ÿ * bcluttering the list or confusing novice users. Users click on the familiar checkbox to select and ˇ ñ d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ]' ( Z ~`deselect items in the custom list. Selection rules apply to the relationship between parent and ° d ONLN d a ] ~ i µ * child items: ,
Zapf Dingbats
° d ONLN d n s ~ | Ö *n
° d ONLN d p q ê }Á )KWhen the user selects/deselects an open parent item, all children are shown ° d ONLN d º } ê â& * Yselected/deselected as well. This helps the user understand the relationship between the ° d ONLN d â ê ï * [parent and child items. Selecting a parent is equal to selecting all the parent’s children ° d ONLN dr ï ê ° ‘ * and vice versa.
° d ONLN dØT ~` *\The Installer only uses the leaf package sizes of the selected custom items to calculate the ° d ONLN d ` ~l * \selected size value. For packages that referenece both atoms and sub-packages, it’s best to ° d ONLN dil ~x+ * ^create another package that contains only the atoms and reference that package in place of the ° d ONLN d»x ~Ñ ú * atoms. ° d ONLN dœå ~ò¶ *XFor example, if you have this: Use this instead:
° d ONLN d(fl ~Ë Δ *Q ° d dPro † Ç ˇˇˇˇˇˇ
† ΔÊË 1¢ ˘≥ ˇˇˇˇˇˇˇˇ 8 † õ ° ñ † ò ° d dPro (
£ ¯±
. ˇ F" F" ° d ONLN dˇˇ (≠ ˚' ° d ONLN dˇˇ )i ° d ONLN dˇˇ )n ° d ONLN dˇˇ )p ° d ONLN dˇˇ )k ° d ONLN dˇˇ )' † ô † ó † ú ˇˇˇˇˇˇ
† ΔÊË 1ª ◊à ˆ ˇˇˇˇˇˇˇˇ 8 † õ ° ñ † ò ° d dPro (
º ◊ ı ° d ONLN dˇˇ (Δ ⁄' ° d ONLN dˇˇ )i ° d ONLN dˇˇ )n ° d ONLN dˇˇ )p ° d ONLN dˇˇ )k ° d ONLN dˇˇ )' † ô † ó † ú ˇˇˇˇˇˇ
† ΔÊË 1ª ˘Ã ˇˇˇˇˇˇˇˇ 8 † õ ° ñ † ò ° d dPro (
º ˙ ° d ONLN dˇˇ ) ' ° d ONLN dˇˇ )i ° d ONLN dˇˇ )n ° d ONLN dˇˇ )f ° d ONLN dˇˇ )a ° d ONLN dˇˇ )' † ô † ó † ú ˇˇˇˇˇˇ
† ΔÊË 1ªÃ9 ˇˇˇˇˇˇˇˇ 8 † õ ° ñ † ò ° d dPro (
º 7 O† ° d ONLN dˇˇ )' O† ° d ONLN dˇˇ )i O† ° d ONLN dˇˇ )n O† ° d ONLN dˇˇ )r O† ° d ONLN dˇˇ )a O† ° d ONLN dˇˇ )' † ô † ó † ú ˇˇˇˇˇˇ
† ΔÊË 1’ »Ê Á ˇˇˇˇˇˇˇˇ 8 † õ ° ñ † ò ° d dPro (
÷ …‰ ‰ ° d ONLN dˇˇ (‡ Ã' ° d ONLN dˇˇ )i ° d ONLN dˇˇ )n ° d ONLN dˇˇ )f ° d ONLN dˇˇ )a ° d ONLN dˇˇ )' † ô † ó † ú ˇˇˇˇˇˇ
† ΔÊË 1’ ÈÊ ˇˇˇˇˇˇˇˇ 8 † õ ° ñ † ò ° d dPro (
÷ ͉ ü ° d ONLN dˇˇ )' ü ° d ONLN dˇˇ )i ü ° d ONLN dˇˇ )n ü ° d ONLN dˇˇ )f ü ° d ONLN dˇˇ )a ü ° d ONLN dˇˇ )' † ô † ó † ú
† ΔÊË "±‡ "± "±# " Ê
" Ê
ˇˇˇˇˇˇ 1¢î≥≥ ˇˇˇˇˇˇˇˇ 8 † õ ° ñ † ò ° d dPro (
£ì±± ° d ONLN dˇˇ (≠ñ' ° d ONLN dˇˇ )i ° d ONLN dˇˇ )n ° d ONLN dˇˇ )p ° d ONLN dˇˇ )k ° d ONLN dˇˇ )' † ô † ó † ú ˇˇˇˇˇˇ
† ΔÊË 1ªrÃë ˇˇˇˇˇˇˇˇ 8 † õ ° ñ † ò ° d dPro (
ºr ê ° d ONLN dˇˇ (Δu' ° d ONLN dˇˇ )i ° d ONLN dˇˇ )n ° d ONLN dˇˇ )p ° d ONLN dˇˇ )k ° d ONLN dˇˇ )' † ô † ó † ú ˇˇˇˇˇˇ
† ΔÊË 1’cÊÇ ˇˇˇˇˇˇˇˇ 8 † õ ° ñ † ò ° d dPro (
÷d‰ ° d ONLN dˇˇ (‡g' ° d ONLN dˇˇ )i ° d ONLN dˇˇ )n ° d ONLN dˇˇ )f ° d ONLN dˇˇ )a ° d ONLN dˇˇ )' † ô † ó † ú ˇˇˇˇˇˇ
† ΔÊË 1’ÑÊ£ ˇˇˇˇˇˇˇˇ 8 † õ ° ñ † ò ° d dPro (
÷Ö‰† ü ° d ONLN dˇˇ )' ü ° d ONLN dˇˇ )i ü ° d ONLN dˇˇ )n ü ° d ONLN dˇˇ )f ü ° d ONLN dˇˇ )a ü ° d ONLN dˇˇ )' † ô † ó † ú
† ΔÊË "±¢‡ "±°# " Å
" Å
ˇˇˇˇˇˇ 1ª∑Ã÷ ˇˇˇˇˇˇˇˇ 8 † õ ° ñ † ò ° d dPro (
º∂ ‘ ° d ONLN dˇˇ (Δπ' ° d ONLN dˇˇ )i ° d ONLN dˇˇ )n ° d ONLN dˇˇ )p ° d ONLN dˇˇ )k ° d ONLN dˇˇ )' † ô † ó † ú ˇˇˇˇˇˇ
† ΔÊË 1’ßÊΔ ˇˇˇˇˇˇˇˇ 8 † õ ° ñ † ò ° d dPro (
÷®‰√ ü ° d ONLN dˇˇ (‡´' ü ° d ONLN dˇˇ )i ü ° d ONLN dˇˇ )n ü ° d ONLN dˇˇ )f ü ° d ONLN dˇˇ )a ü ° d ONLN dˇˇ )' † ô † ó † ú ˇˇˇˇˇˇ
† ΔÊË 1’…ÊË ˇˇˇˇˇˇˇˇ 8 † õ ° ñ † ò ° d dPro (
÷…‰Â œ† ° d ONLN dˇˇ )' œ† ° d ONLN dˇˇ )i œ† ° d ONLN dˇˇ )n œ† ° d ONLN dˇˇ )r œ† ° d ONLN dˇˇ )a œ† ° d ONLN dˇˇ )' † ô † ó † ú
† ΔÊË " ≈
" ≈
† É
d
. ° d ONLN dˇˇ + u
° d ONLN dD¸ ~ ( ~Custom Item Information " ° ∂
|
0 ° ∂ ° ∂
° d ONLN d\ ~ *[Custom item information can be viewed in a separate info dialog by clicking on the button ( † Ç † é
" ê epep" ¿Ä$Ñ0Ä4å?Ñ?Ñ?é?Ä0?Ï † è † É
d ° d ONLN d∑$ ( ($) ° d ONLN dπ ~(Û (% ~Vto the right of custom item text. The custom item info dialog is shown in Figure 2-4. ˇ˛ d ˇ ˇˇˇˇ d
d , Palatino
. +~*C H A P T E R 2 , Helvetica
*Installer Human Interface (Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ú16 ° d ONLN d Q ~ \ ∞ ( Y ~
Figure 2-4 ° d ONLN d Q Ω \. )?The Custom Item Info Dialog † Ç † é
_ ~jú ò $8±çœ8±çœ _ ~ ¥ú fiˇ ¸ Äfl Äfl üflˇ ‰ üflˇ ‰ òfl d òfl d òfl d òfl e òfl g òfl d òfl d òfl d òfl d òfl d òfl d òfl d ò ?ˇÂ d
ò @ ÄÊ d
ò @@ ÄÄÊ d
ò @?ˇ ÄÊ d
ò @˛ ÄÊ d
ò @˛ ÄÊ d
ò @ ÄÊ d
ò @ ÄÊ d
ò C˛/ËÄÊ d
ò D((ÄÊ d
ò E˝((ÄÊ d
ò E((ÄÊ d
ò E/ËÄÊ d
ò E ÄÊ d
ò E˝ ËÅÂÄ Ä ÄÏ d ò D Å Ä"ÄÍ dò D Å ò „-∏‡Ì dò D ѧ ê∞• Ì dò D ź솕 Ì dò C˛ ņ" Ì dò C˛ Åò 솧‡Ì dò @@ Ä˚ Ì dò @@ Ä˚ ¿Ì d
ò @‡ ÄÊ d
ò @‡ ÄÊ d
ò Gø˝ÙÄÊ d
ò @˛ ÄÊ d
ò @˛ ÄÊ d ò ?¯ˇÂ d ò˛ ‰ d ò˛ ‰ d ò˛ ˛‰ d òfl d òfl d òfl d òfl d òfl d òfl d òfl d òfl d òfl d òfl d òfl d òfl d òfl d òfl d òfl d ò˝
„ „àÓ d ò˝ 0˛ DêÓ d ò˝
πÌÉ|·Äà†Ó d ò˝
õ„∞œ¿Ó d ò˝
ôŒ 31 (à†Ó d ò˝
o3aÄ(àêÓ d ò˝
ÕÅ„|·Å«àÓ d òfl d òfl d òfl d òfl d òfl d òfl d òfl d
òı Ï d ò˝ > aÅ„˛ Ï d ò˝ 3 sÉ0˛ Ï d ò˝ 3 É|·ÉÇ0Ì d ò˝ > mÅ„∞DÌ d ò˝ <?aÄ31D8Ì d ò˝ 63aÉ3aÄHHÌ d ò $籂œç±‚œ ¥ ~ ú ò˝ 33aÅ„|·ÇH8Ì d òfl d òfl d òfl d òfl d òfl d òfl d òfl d òfl e ò¸ ¿ ‡@ Ó g ò¸ ¿¸ ¿`Ó d ò¸ Œ|˜9·Ä@@ Ó d ò¸ õqÉm∞ @@ Ó d ò¸ ü`„m∞ Ä@ Ó d ò¸ `3m∞ Ä@ Ó d ò¸ a„9±ÄÑB Ó d òfl d òfl d òfl d òfl d òfl d òfl d òfl d òfl d ò˙ Ä Ë @¡¬ „Çı d ò˙ ¿ à @B& 1Fı d ò˙ g<·ÄéH R@" Jı d ò˙ aô∞ âH R@B Û“ı d ò˙ gô âHR@Ç _ı d ò˙ ÕôÄ âHRA Çı d ò˙ áå·Äâ8ÉéC‚√ı d òÛ Ä˛ Ú d òÙ ˝ Ú d òfl d òfl d òfl d òfl d òfl d òfl d òfl d òfl d òfl d òfl d òfl d òfl d òfl dò·ˇ d
ò„ Ä dò·ˇ d òfl d òfl d òfl d òfl d òfl d òfl d òfl d òfl d òfl d òÎ ¯ˇ d òÎ ¯ˇ¸ d òÎ ?¯ˇ˛ d òÎ |¯ d òÎ q¯ˇ« d òÎ ˆ¯ 7Äd òÎ ‰¯ Äd òΠ˯ Äd òΠ˯ Äd òΠ˲ Δ0˛ Äd òΠ˲ f`˛ Äd òΠ˲ f¿˛ Äd òΠ˲ gIJ Äd òΠ˲ g˝ Äd òΠ˲ gIJ Äd òΠ˲ f¿˛ Äd òΠ˲ f`˛ Äd òΠ˲ Δ0˛ Äd òΠ˯ Äd òΠ˯ Äd òΠ˯ Äd òÎ ‰¯ Äd òÎ ˆ¯ 7Äd òÎ q¯ˇ« d òÎ |¯ d òÎ ?¯ˇ˛ d òÎ ¯ˇ¸ d òÎ ¯ˇ d òfl d ò $7±Cœ7±Cœ^ ~jú òfl d òfl d òfl d òfl d òfl d òfl d òfl d üflˇ ‰ üflˇ  Äfl Äfl fiˇ ¸ † è † É
d
° d ONLN d 'Ç 6ñ (ë 6Custom Remove Interface " ° ∂ ñ 4ñ0 ° ∂ ° ∂
° d ONLN d ?õ ~ß +H^Prior to Installer 4.0, the user had to hold down the option key to enable the remove feature. ° d ONLN d üß ~≥ * UBy selecting the Custom Remove pop-up menu item, the user can go to the Custom Remove ° d ONLN d ı≥ ~ø • * window. ˇ Ç d ˇ ˇˇˇˇ d
d , Palatino
. +~*C H A P T E R 2 , Helvetica
*Installer Human Interface (Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ú17 ° d ONLN d Q ~ \ ∞ ( Y ~
Figure 2-5 ° d ONLN d Q Ω \* )?The Custom Remove dialog † Ç † é
a 6Ü ò >"OS2"OS2 a 6 í ≈ˇ’U ÄΔ ` ÄΔ ` ÄΔ ` øÌˇÔ ˇ˚ˇø` ÄÏ ‡ ˛ ů `0Ì Ä` øÌˇê ˛ ÅÄ `0 ˇ˙ø` ÄÌ É1«è ÅÄ |8Ò„1„`Ô Ä` øÌˇ
° d ONLN d $ê ~ú (ô ~WThe Custom Remove window layout looks very similar to that of Custom Install. The main ° d ONLN d |ú ~®. * _difference is that the items in the Custom Install list which are not removable are dimmed, and ° d ONLN d ‹® ~¥' * &the Install button is titled “Remove”.
° d ONLN d+ ~Ò& +HaIf the scriptwriter allows the user to select a target folder, a modified Standard File dialog is ° d ONLN dçÒ ~˝ * Zshown when the user clicks the Select Folder button. The Select Folder dialog is shown in ° d ONLN dË˝ ~ Æ * Figure 2-6. ˇ ( d ˇ ˇˇˇˇ d
d , Palatino
. +~*C H A P T E R 2 , Helvetica
*Installer Human Interface (Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ú18 ° d ONLN d Q ~ \ ∞ ( Y ~
Figure 2-6 ° d ONLN d Q Ω \ )?The Select Folder dialog ° d WORD ÿv
° d ONLN d $E ~Q) (N ~dTo select a target folder using the Select Folder dialog, the user selects the folder or disk in the ° d ONLN d âQ ~]. * flist, and then clicks the Select button. If no items are selected, clicking the Select button chooses ° d ONLN d ] ~i* * _the folder or disk whose contents are showing in the list. The Open button is enabled whenever ° d ONLN dPi ~u$ * fa folder, disk or alias is selected in the list. If the folder or disk is not a valid target disk the ° d ONLN d∑u ~Å“ * NSelect button is disabled, such as for a locked floppy disk or a sever volume. ° d ONLN dâ ~ï# *\The Installer always recommends a target application folder to the user when first launching ° d ONLN dcï ~°' * athe Installer. The user is shown the contents of the folder when first opening the Select Folder ° d ONLN d≈° ~≠ * adialog. If the folder does not already exist, the folder is created so the user can either click ° d ONLN d'≠ ~πÉ * 8Cancel or Select and maintain the recommended selection.
° d ONLN d`√ ~Œ ö *NOTE
° d ONLN de— ~›, *`We suggest that scriptwriters place the application and associated files and folders directly in ° d ONLN dΔ› ~È * Zthe recommend target folder. This provides a visual association between the folder in the ° d ONLN d!È ~ı- * `Installer’s dialog and the application folder of the same name that is created on the hard disk. ° d ONLN dÉı ~± * EThis also allows an existing application to be updated more easily. ,
Zapf Dingbats
° d ONLN d»˜± ∏ (˛±u
° d ONLN d 6-' (( 6Selecting the System Volume " ° ∂ - 4-0 ° ∂ ° ∂
° d ONLN dÊ2 ~> +HWScriptwriters can allow the user to change the recommended system volume when using the ° d ONLN d>> ~J * ^application folder interface. A flag in the preference resource determines if this feature is ° d ONLN dùJ ~V( * _enabled. The Installer initially recommends that system files be installed on the boot volume. ° d ONLN d˛V ~b * [The scriptwriter can override this recommendation using the Setup Function described in the ° d ONLN dZb ~n\ * 2section “Using the Installer Preference Resource”. ° d ONLN dçv ~Ç *VThe user accesses the Select System Volume dialog by holding down the Option key while ° d ONLN d‰Ç ~é * Zclicking the Select Folder button. The Select System Volume dialog is shown in Figure 4-6. ˇv d ˇ ˇˇˇˇ d
d , Palatino
. +~*C H A P T E R 2 , Helvetica
*Installer Human Interface (Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ú19 ° d ONLN d Q ~ \ ∞ ( Y ~
Figure 2-7 ° d ONLN d Q Ω \C )? The Select System Volume dialog † Ç † é
_ ~ ⁄í ò $Ä∂’ Ä∂’ _ ~ ¥í flˇ˛c ć G ć ü‡ˇí ü‡ˇü‡ ò· ê ò· ê ò· ê ò· ê ò· ê˛ ò· ê@ ò· ó1 ò· íR ò· õ¡ ò· îÇ ò· úp ò· ê‰ ò· ò· ò· ò· ò· ò·% ò k l Ä¿ @ ¿ @H˛ ò·%ò " Å˛ $ @ @ @ @@˛ ê% ò ë‹Œ¡Ÿ1¬ $8¡∏ÓbLpgqÅÃLg1¡Ÿ“˛ ò % ò í ) âJQ$% •RêîÇJBRíJBJ˛ ô3% ò ëâÈ âyÅQ$%‡§ƒr^êîÇK¡û^ÇzBIò˛ ôò% ò "êI â@@°$% §$íPêîÇJ PPíBBHT˛ ê%#ò sÑ… â3Ä°$8¿•¬rLpdÅIÉåLa1¡Àí@ ëê ò ‰ ò ò `‰ ñ1 ò· ëΔ ò· ê ò· ù ò· ê
ò· ë ò· ë ò· ë ò· ù ò· ì ò· î„ ò· õ ò· î ò· í ò· ê ò· ëê ò· êò ò· õÄ òÙ ÔˇÄôô
òÌ ˜ˇ ò· òÌ ¯ˇ˛ ò· òÌ ¯ˇ¯ ê ò· ò ò· ô3 ò· ôò ò· ê ò· ëê ò· ò ò· ñ1 ò· ëΔ ò· ê ò· ù ò· ê
ü‡ˇë ü‡ˇë ć ć flˇÛ † è † É
d
° d ONLN d + ‚ ~ Ó" ( Î ~\The user can change the currently selected system volume by choosing a different volume from ° d ONLN d à Ó ~ ˙( * ]the pop-up menu. Only valid system volumes (those that contain blessed folders) are shown in ° d ONLN d Ê ˙ ~ ™ * the menu.
° d ONLN d 62 ˘ (- 6Adding a Splash Screen " ° ∂ 2 420 ° ∂ ° ∂
° d ONLN d7 ~C +H_The first screen to be displayed when the Installer is launched is found in the script. If you ° d ONLN dgC ~Oö * ?would like to provide your own splash screen, simply include a ,
Courier ° d ONLN d¶CöOæ (Lö'PICT' ° d ONLN d¨CæO )$ resource named ° d ONLN dºCO, )H“Splash ° d ONLN dƒO ~[ † (X ~Screen” ° d ONLN dÀO †[ )"X with a resource ID greater than 1024. The Installer loads the picture from the script ° d ONLN d$[ ~g) (d ~`and displays it, along with an OK button in the lower right corner to dismiss the splash screen. ° d ONLN dÖo ~{ø *HYou can also have a color splash screen. In addition to the PICT named ° d ONLN dÕoø{ (xø“Splash Screen”, ° d ONLN dfi{ ~á ˙ (Ñ ~include a color PICT named ° d ONLN d˘{ ˙á_ )|“Color Splash Screen” ° d ONLN d{_á& )e0. If the screen has a depth of 4 bits per pixel ° d ONLN d?á ~ì- (ê ~bor greater (16 colors/grays or more) then the Installer will use this PICT instead. Note that you ° d ONLN d¢ì ~üÜ * =should use the default system color palette for best results. ° d ONLN d‡ß ~≥, *aCreate a picture using a drawing or painting program. You will want your picture to be no bigger ° d ONLN dB≥ ~ø5 * (than 220 (height) by 433 (width) pixels. ° d ONLN dk« ~”+ *\The AppleGaramond font is recommended for titles and the help screen fonts included with the ° d ONLN d»” ~fl * `SDK for text. Since you cannot be sure your chosen fonts will always be available, it’s best to ° d ONLN d)fl ~Î * Zcreate a bitmap picture when using fonts other than Geneva 9, 12, Chicago 12 and Monaco 9. ° d ONLN dÑÛ ~ˇ *`If necessary, convert the picture to a bitmap and copy it into the clipboard. Paste the picture ° d ONLN d¡ ~ * \from the clipboard into a newly created ResEdit file. This should create several resources, ° d ONLN dB ~ ≤ * including a ° d ONLN dN ≤ ÷ )4'PICT' ° d ONLN dT ÷ )$B resource. Delete all of the resources you’ve created except the ° d ONLN dñ ('PICT' ° d ONLN dú )$. ° d ONLN dü ~# œ ( ~Save the ResEdit ° d ONLN d∞ œ# Û )Q'PICT' ° d ONLN d∂ Û# )$ file. ° d ONLN dΩ+ ~7 ÷ (4 ~DeRez the ResEdit ° d ONLN dœ+ ÷7 ˙ )X'PICT' ° d ONLN d’+ ˙7¯ )$5 file using MPW. We use the following DeRez command: ° d ONLN d ; êG. (D êEDeRez 'ResEdited-Splash' -only PICT {MPW}RIncludes:Pict.r >> Script.r ° d ONLN dRJ ~V[ (S ~/This command appends the Rez definition of the ° d ONLN dÅJ[V )›'PICT' ° d ONLN dáJVÎ )$ to the end of your script , Monaco
° d ONLN d°JÎUÒ )l.
° d ONLN d£^ ~j= (g ~+Open the script file you just appended the ° d ONLN dŒ^=ja )ø'PICT' ° d ONLN d‘^aj )$* to, go to the end, change the name of the ° d ONLN dˇj ~v ¢ (s ~'PICT' ° d ONLN dj ¢vã )$8 resource (or give it a name if it doesn’t have one) to ° d ONLN d=jãv’ )È“Splash Screen” ° d ONLN dLj’v. )J, and ensure that its ° d ONLN dbv ~Ç" ( ~^ID is greater than 1024. Your script now contains the picture in a format Rez can handle when ° d ONLN d¡Ç ~é0 * )building the script into resource format. ˇ!é d ˇ ˇˇˇˇ d
° d ONLN d Q 6 e fl ( ` 6Providing User Help " ° ∂ e 4 e0 ° ∂ ° ∂
° d ONLN d j ~ v +HVClicking the Help button in the Installer window opens the Installer Help window which ° d ONLN d k v ~ Ç * ]displays PICTs stored in the Installer or script file. The Installer Help window is shown in ° d ONLN d … Ç ~ é Æ * Figure 2-8.
° d ONLN d ’ ñ ~ ° ∞ *
Figure 2-8 ° d ONLN d ‡ ñ Ω °" )?The Installer Help window † Ç
§ ~µ1 ò 8 ‡ @Ò ‡ GÒ˙ § ~µ1 Àˇ Ä À ¿ À ¿ À ¿~ˇÔÏˇ ˝ ͡˛¿ Ä Î ÄÁ ¿~Ä/ÏˇÄ Íˇ˛¿ Ä Î èË ¿~Ä/Ïˇôôò͡˛¿ Ä Î ôôòË ¿~Ä/Ïˇüôò͡˛¿ Ä Î òòË ¿~Ä/Ïˇòôò͡˛¿ Ä Î èË ¿~ˇÔÏˇ Ä͡˛¿ Ê ÄË ¿ À ¿ À ¿ Àˇ ¿
° d ONLN d ˙… ~’ (“ ~[The Installer ships with several simple help screens, but you can override specific default ° d ONLN dV’ ~·" * _screens and add to the default help pages. The Preference Resource contains a list of the help ° d ONLN d∂· ~Ìfi * Ppages and is discussed in the section “Using the Installer Preference Resource”.
° d ONLN d˜ ~ ö *NOTE
° d ONLN d ~ *_Easy-to-read screen fonts, as seen in Figure 2-8, are included in the SDK for your convenience. ° d ONLN dm ~ Î * RWe suggest that you use these fonts for your help window and splash screen text. ,
Zapf Dingbats
° d ONLN døÎ Ú (Îu
° d ONLN d¡5 6IB (D 6 Selecting an Installer Document " ° ∂ I 4I0 ° ∂ ° ∂
° d ONLN d·N ~Z +HXWhen the user opens the Installer application directly the Installer searches the folder ° d ONLN d:Z ~f * ]containing the application for one valid document. If no documents or multiple documents are ° d ONLN dòf ~rã * <found the Installer displays the dialog shown in Figure 2-9. ˇ ∂ d ˇ ˇˇˇˇ d
d , Palatino
. +~*C H A P T E R 2 , Helvetica
*Installer Human Interface (Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ú21 ° d ONLN d Q ~ \ ∞ ( Y ~
° d ONLN d ) ~ ( ~VClicking Choose displays the standard Open Dialog so the user can choose one Installer ° d ONLN d Ä ~(… * Jdocument to open. Clicking Cancel in the Open Dialog quits the Installer. ° d ONLN d À0 ~<. *dAfter opening the Installer document the Installer looks for the script version resource (‘invs’) to ° d ONLN d0< ~H% * _determine if the version of the Installer application is properly matched to the version of the ° d ONLN dêH ~T * ]script. With Installer version 4.0.3 and newer, the Installer will allow the user to open a ° d ONLN dÓT ~`) * adocument with a smaller version than the Installer. If this is the case, the Installer shows the ° d ONLN dP` ~l fi * dialog in Figure 2-10.
° d ONLN dgt ~ ∞ *
Figure 2-9 ° d ONLN drt ΩJ )?!The Early Version Document Dialog
° d ONLN dîb 6v q (q 6Menus " ° ∂ v 4v0 ° ∂ ° ∂
° d ONLN dö{ ~á# +H^To allow the user to easily switch processes and to turn balloon help on and off the Help menu ° d ONLN d˘á ~ì * Yand Application menus will be shown under System 7.X. An “About Installer…” item will be ° d ONLN dSì ~ü Û * shown in the Apple menu. ˇÇ d ˇ ˇˇˇˇ d
° d ONLN d d ~ p( *]The Apple Menu will be shown in full when running under 7.X, but will only contain the “About ° d ONLN d j p ~ | * \Installer…” item when running on pre-7.0 systems. Desk Accessories will not be shown in the ° d ONLN d « | ~ àÔ * Rmenu under pre-7.0 systems to restrict DAs from being opened within the Installer.
° d ONLN d ê ~ õ ∂ * Figure 2-10 ° d ONLN d& ê Ω õ )?The Apple Menu. † Ç
û ~ ƒ ò U ∏{PU ª{P û ~ ƒ ˛ˇÒ ˛ˇÒ ˇœˇÒ ˇüˇÒ ˇøˇÒ ¸GˇÒ ¯ˇÒ ¯ˇÒ ¯ˇÒ ¯ˇÒ ¯ˇÒ ¸ˇÒ ˛OˇÒ ˛ˇÒ ˛ˇÒ ˛ˇÒ ˛ˇÒ ˛ˇÒ ˇ˛ ø ò ø üû <xÃxÿ˛ ˛ôåôåÃDz ˛ôåú|Ãÿ˛ ˛ôåéÃø¿˛ ˛ôåáÃÿ¿˛ ˛ô
åìÃáôÄ üÜé |Ãx¡ôÄ Ôˇ Ôˇ † É
d
° d ONLN d6 ÿ ~ Á ¬ ( „ ~ Help Menu " ° ∂ Ê | Ê0 ° ∂ ° ∂
° d ONLN dA Î ~ ˜ *[The Help menu will be available to users when running under System 7.X. In addition to the ° d ONLN dù ˜ ~ * Wstandard two menu items the Installer will add an “Installer Help…” item that opens the ° d ONLN dı ~ Ó * Installer’s help window.
° d ONLN d ~" ∂ * Figure 2-11 ° d ONLN d Ω" ˚ )?The Help Menu. † Ç
% ~ä! ò ∞ P ∞ V ˘% ~ä! Ò ˝ˇ Ò ˇÄˇ Ò ˇ˚ˇ Ò ˛¯}ˇ Ò ˛Û=ˇ Ò ˛Û=ˇ Ò ˛˛}ˇ Ò ˛¸˝ˇ Ò ˛¸˝ˇ Ò ˛ˇ˝ˇ Ò ˛¸˝ˇ Ò ˛¸˝ˇ Ò ˇ˚ˇ Ò ˇ∞ˇ Ò ˇØˇˇ Ò ˇüˇˇ Ò ˇøˇˇ Ò ˝ˇ Ìˇ Ó Ó Ó Ä
Ò ¿ Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä ÌU Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Δ˛ ¿`¯ Ä &˛ ``¯ Ä √ΔfcΔc√«√ĸ Ä Ü˛fd¸f @¸ Ä Δ˛f√Ê˛f g˚ Ä Ê˛f ¸fcĸ Ä ˝f ¸fa¿¸ Ä ˛fd¸fd¿¸ Ä Δc«¯√Êc√Δcĸ Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä ÌU Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ó Ä Ã 3 0˙ Ä Ã 3 0˙ Ä
<xÃxÿ3 3‡˚ Ä ôåÃDz3 0˚ Ä
ú|Ãÿ?330˚ Ä
éÃø¿3?30˚ Ä
áÃÿ¿3030˚ Ä ìÃÿ3131ôÄ˝ Ä é |Ãx¿3 3·ôÄ˝ Ä ˆ ˙ Ä ˆ ˙ Ä Ó Ä Ó Ä Ìˇ Ä Óˇ Ä † É
d
° d ONLN d)í ~û∞ (õ ~BThe Help menu is not available when running under pre-7.0 systems.
° d ONLN dl≤ ~¡ Í *"Application Menu " ° ∂ ¿ |¿0 ° ∂ ° ∂
° d ONLN d~≈ ~—* *]The Application menu will be available to users when running under System 7.X. Under pre-7.0 ° d ONLN d‹— ~› * Usystems using MultiFinder the user can switch between applications by clicking on the ° d ONLN d2› ~È Õ * MultiFinder icon.
° d ONLN dDÒ ~¸ ∂ * Figure 2-12 ° d ONLN dPÒ Ω¸ )?The Application Menu. † Ç
° d ONLN d Q ~ ] ( Z ~\The fields and flags in the preference resource control two main areas of the Installer, the ° d ONLN d ] ] ~ iÓ * Precommended target disk/folder selection, and specific human interface elements.
° d ONLN d Æ } ~ åß *",Controlling the Recommended Target Selection " ° ∂ ã | ã0 ° ∂ ° ∂
° d ONLN d € ê ~ ú! *\The Installer automatically recommends the target disk, target folder and system disk if the ° d ONLN d8 ú ~ ® * ascriptwriter does not provide a preference resource in the script file. If you wish to allow the ° d ONLN dö ® ~ ¥! * auser to select a target folder then it’s important to at least provide a suggested folder name in ° d ONLN d¸ ¥ ~ ¿( * _your preference resource. To have more control over the recommended target disk, target folder ° d ONLN d\ ¿ ~ Ã, * aand system disk you can supply a code resource to be called to determine these values. This code ° d ONLN dæ Ã ~ ÿ? * .resource is referred to as the setup function. ° d ONLN dÌ ‡ ~ Ï *]The setup function can recommend the initial values for target disk, target folder and system ° d ONLN dK Ï ~ ¯ * _disk, but the Installer will consider these new values only as suggestions and will not use any ° d ONLN d´ ¯ ~ * `value that would be unreasonable. The setup function is called prior to rule execution, or if a ° d ONLN d ~≤ * Fsplash screen is provided, after the user dismisses the splash screen. ° d ONLN dT ~$ *^If no setup function is supplied, or a value recommend by the setup function is not valid, the ° d ONLN d≥$ ~0ö * AInstaller selects the target values using the following strategy: ,
Zapf Dingbats
° d ONLN dı: ~C Ö *n
° d ONLN d˜8 êD! )ZTarget disk — The Installer first looks for the selected boot disk (value stored in PRAM), ° d ONLN dRD êP& * Zthen looks at the SCSI ID 0 hard disk, then at the other SCSI disks, then for an old HD 20 ° d ONLN d≠P ê\
* Phard disk, then any mounted floppies, then the RAM disk, and finally any mounted ° d ONLN d˛\ êh ¥ * volume.
° d ONLN dr ~{ Ö (y ~n
° d ONLN dp ê|' )[Target application folder — Selects the folder with the name specified in the script file’s ° d ONLN dd| êà( * _preference resource on the root level of the target disk. If the scriptwriter does not provide ° d ONLN dƒà êî% * _a preference resource, the preference resource in the Installer file will be used. The current ° d ONLN d$î ê†? * &default folder name is “Applications”.
° d ONLN d§ˇ ~ - *aThe preference resource holds the list of ‘PICT’ resource IDs that specify the pages shown in the ° d ONLN d ~ Ω * help window. ° d ONLN d ~+u *6The help window is divided into two vertical sections:
° d ONLN d K5 ~> Ö *n
° d ONLN d M3 ê? )WGraphic Section — This section begins at the left edge of the window and extends to the ° d ONLN d •? êK * Yright edge of the window. Most often you’ll use this section to display a 100 pixel wide ° d ONLN d ˇK êW * Zcolor graphic that can be shared among several pages. This strategy saves disk space. If ° d ONLN d
ZW êc * Vyou have simple help pages that are all B/W, then use this section to display a ‘PICT’ ° d ONLN d
±c êo * Xresource that is the same width as the help window. Enter zero for the ID to leave this ° d ONLN d
o ê{ Œ * section blank.
° d ONLN d Ö ~é Ö (å ~n
° d ONLN d É êè& )ZText Section — This section begins 100 pixels from the left edge of the window and extends ° d ONLN d vè êõ * \to the right edge of the window. This section is used most often to hold text that does not ° d ONLN d ”õ êß® * Bcontain color. Enter zero for the ID to leave this section blank. ° d ONLN d Ø ~ª! (∏ ~]Two ‘PICT’ resource IDs must be entered for each section, one for display on B/W monitors and ° d ONLN d tª ~« * ]the other for monitors displaying 256 or more colors/grays. You may use the same ID for both ° d ONLN d “« ~” * ^color and B/W ‘PICT’ IDs. Use the special ID of 0 (zero) to display white space in a section. ˇ0 d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ]" ( Z ~\The Installer ships with several basic help pages, which you can add to or replace with your ° d ONLN d ] ] ~ iJ * 0own ‘PICT’ resources stored in your script file.
° d ONLN d é } ~ åü *"-Allowing Installation onto AppleShare Volumes " ° ∂ ã | ã0 ° ∂ ° ∂
° d ONLN d º ê ~ ú ¨ *
Using the ,
Courier ° d ONLN d Δ ê ¨ ú ).allowServerAsTarget ° d ONLN d Ÿ ê ú% )r; flag allows the user to select and install onto AppleShare ° d ONLN d ú ~ ®. ( • ~bvolumes. This flag is an unsupported and untested feature, and is available only as a courtesy to ° d ONLN dx ® ~ ¥. * `those developers that have hacked previous versions of the Installer to gain this functionality. ,
Zapf Dingbats
° d ONLN dŸ æ l » u ( Δ ls
° d ONLN d€ æ ~ … ¡ )
W A R N I N G
° d ONLN dÈ Ã ~ ÿ *\Only those scriptwriters that absolutely, positively, must allow their users to install onto ° d ONLN dF ÿ ~ ‰A * )AppleShare server volumes should use the ° d ONLN do ÿA ‰≥ )√allowServerAsTarget ° d ONLN dÇ ÿ≥ ‰- )r flag! You should never try ° d ONLN dü ‰ ~ ç ( Ì ~=to install anything into the server volume’s System Folder!
\ ° d ONLN d·® ê¥ ∫ (± êboolean ° d ONLN dÈ® Δ¥‘ )6-dontAllowServerAsTarget, allowServerAsTarget; ° d ONLN d®
¥ (±
\ ° d ONLN d ≥ êø fi (º ê
fill bit[10]; ° d ONLN d*… ~’ Ã (“ ~
type 'inpr' { ° d ONLN d:‘ ¢‡ “ +$ switch { ° d ONLN dFfl ¥Î +
case format0: ° d ONLN dXÍ Δˆ& + key integer = 0; ° d ONLN djÍDˆ‘ )~/* Preference version */ ° d ONLN dáı Δ& (˛ ΔpreferenceFlags; ° d ONLN dôıD» )~/* Preference Flags */ ° d ONLN d¥ Δ & ( Δliteral longint; ° d ONLN dΔ D ⁄ )~/* Setup Function Type */ ° d ONLN d‰ Δ ˆ ( Δinteger; ° d ONLN d 2¯ )l!/* Setup Function Code Rsrc Id */ ° d ONLN d Δ"» ( Δ+unsigned integer = $$CountOf(helpPagelist); ° d ONLN dG! Δ-\ * wide array helpPagelist { ° d ONLN df, ÿ82 + /* Help Page */ ° d ONLN d{7 ÿC * integer; ° d ONLN dá7DC )l#/* B/W Graphic Section ‘PICT’ ID */ ° d ONLN d∞B ÿN (K ÿinteger; ° d ONLN dºBDN )l /* B/W Text Section ‘PICT’ ID */ ° d ONLN d‚M ÿY (V ÿinteger; ° d ONLN dÓMDY" )l%/* 8-Bit Graphic Section ‘PICT’ ID */ ° d ONLN dX ÿd (a ÿinteger; ° d ONLN d%XDd )l"/* 8-Bit Text Section ‘PICT’ ID */ ° d ONLN dLc Δo “ (l Δ}; ° d ONLN dSn Δz> * pstring; align word; ° d ONLN dhnDz⁄ )~/* Default Folder name */ ° d ONLN dÖy ¢Ö Æ (Ç ¢}; ° d ONLN dàÑ ~ê ä (ç ~};
° d ONLN dãï ~† ‘ *Flag descriptions
° d ONLN dù£ ~Ø\ *%useDiskTargetMode/useFolderTargetMode ° d ONLN dƒÆ∫ +ê <Specifies whether the user can choose a target folder, or is ° d ONLN d∫Δƒ * +limited to choosing a target disk. If the ° d ONLN d,∫ƒΔ* )∂useDiskTargetMode ° d ONLN d>Δ“ (œ>flag is specified, “Switch Disk ” and “Eject Disk” buttons are ° d ONLN d}“fi) * Bshown to the user. This is very similar to the old Installer 3.X. ˇË d ˇ ˇˇˇˇ d
ÿ" ‰≤ )allowUserToSetSystemDisk ° d ONLN d" ÿ≤ ‰& )ê flag is ignored unless the ° d ONLN d? ‰ ( Ì;useFolderTargetMode flag is set (see section above). If the ° d ONLN d{ ¸ * 9useDiskTargetMode flag is used, there is no change to the ° d ONLN dµ ¸ * 4“SwitchDisk” button when the Option Key is pressed. ° d ONLN dÍ ~ º ( ~5dontShowSelectedSizeInCustom/showSelectedSizeInCustom ° d ONLN d '* +ê =Specifies whether the Installer should calculate and show the ° d ONLN d^'3# * ?total size of the currently selected custom items in the Custom ° d ONLN dû3?, * Aand Remove Install interfaces. Since the Installer does not look ° d ONLN d‡?K# * >at the target disk when calculating this value, it will almost ° d ONLN d KW) * ;always be overestimated. Common packages are only included ° d ONLN d[Wc * >once in the calculation, but for some scripts this may confuse ° d ONLN döco™ * #more than help the user, so use the ° d ONLN dæo{∂ * dontShowSelectedSizeInCustom ° d ONLN d⁄o∂{ )® flag to hide the field. ° d ONLN dÙ{ᬠ(Ñ(Showing the field is the default action. ° d ONLN d è ~õå (ò ~-noSetupFunctionSupplied/setupFunctionSupplied ° d ONLN dKö¶( +ê ?Specifies whether the Installer should call the setup function. ° d ONLN då¶≤ * ;The type and ID of the setup function code resource must be ° d ONLN d»≤æ◊ * -entered in the setup function fields when the ° d ONLN dˆæ å * setupFunctionSupplied ° d ONLN d æå ⁄ )~ flag is specified. ° d ONLN d “ ~fiò (€ ~/dontAllowServerAsTarget/dontAllowServerAsTarget ° d ONLN dO›È. +ê @Specifies whether the Installer should allow the user to install ° d ONLN dêÈıä * onto AppleShare volumes. ° d ONLN d™Èäı¡ )|WARNING ° d ONLN d±È¡ı )7: This flag is an ° d ONLN dƒı (˛<unsupported and untested feature, and is available only as a ° d ONLN d
* 6courtesy to those developers that have hacked previous ° d ONLN d8
' * Aversions of the Installer to gain this functionality. Only those ° d ONLN dz% * ;scriptwriters that absolutely, positively, must allow their ° d ONLN d∂%1( * >users to install onto AppleShare server volumes should use the ° d ONLN dı1=Ä * allowServerAsTarget ° d ONLN d1Ä=$ )r& flag! You should never, ever install ° d ONLN d/=Iœ (F)anything into the volume’s System Folder!
° d ONLN dZS ~^ ◊ ([ ~Field descriptions
° d ONLN dma ~mD *!Setup Function Code Resource Type ° d ONLN dèlx+ +ê BThe resource type of the setup function code resource. This field ° d ONLN d“xÑk * is ignored unless the ° d ONLN dËxkÑÈ )]setupFunctionSupplied ° d ONLN d˝xÈÑ )~ flag is ° d ONLN d Ñê‡ (ç2specified. The type is usually ‘infn’. (4-bytes) ° d ONLN d :ò ~§8 (° ~ Setup Function Code Resource ID ° d ONLN d [£Ø, +ê CThe resource ID of the setup function code resource. This field is ° d ONLN d üتa * ignored unless the ° d ONLN d ≤Øaªfl )SsetupFunctionSupplied ° d ONLN d «Øflª- )~ flag is specified. ° d ONLN d ‹ª«7 (ƒ (2-bytes) ˇ d ˇ ˇˇˇˇ d
Q ] )ê;Four resource IDs of ‘PICT’ resources that make up one help ° d ONLN d F ] iä * page. ( Four 2-byte values ) ,
Courier ° d ONLN d d q ~ }2 ( z ~ Recommended Target Folder Name ° d ONLN d É | à& +ê =The recommended target folder name. This can be specified at ° d ONLN d ¡ à î' * ?run-time by the scriptwriter in the setup function. As with any ° d ONLN d î † * 9file name, the length should be limited to 31 characters, ° d ONLN d; † ¨ * <although the Installer will truncate the string if too long. ° d ONLN dy ¨ ∏é * (even-padded Pascal string)
° d ONLN d• · ~ Ì+ +HcThe setup function is a code resource specified in the preference resource that is passed a pointer ° d ONLN d Ì ~ ˘ * \to a parameter block with information about the Installer’s environment. The entry point of ° d ONLN df ˘ ~> * +this code resource must have the interface: ° d ONLN dí ~ ú *OSErr ° d ONLN dò ¢Œ )$2EnvironmentSetupFunction( EnvironmentSetupPBPtr ); ° d ONLN dÀ# ~/ (, ~^Return the result code noErr to have the Installer continue as normal. Return the result code ° d ONLN d*/ ~; ‰ * kQuitInstallerNow ° d ONLN d;/ ‰; )fG to force the Installer to quit immediately. Returning any other value ° d ONLN dÉ; ~Gƒ (D ~Mwill cause an error alert to be display before forcing the Installer to quit. ° d ONLN d—O ~[ *[The parameter block contains the Installer’s suggested target application folder and system ° d ONLN d-[ ~g * Ydisk. The fields in the parameter block can be changed to override the suggested values. ° d ONLN dák ~w ‰ *typedef struct { ° d ONLN dôv ~Ç ê * —> ° d ONLN dùv ¢Ç à )$ProcPtr ° d ONLN dßv ¸Çb )ZfCallBackProcPtr; ° d ONLN dπÅ ~ç ê (ä ~<—> ° d ONLN dΩÅ ¢ç Δ )$FSSpec ° d ONLN dΔÅ ¸çP )ZfTargetFSSpec; ° d ONLN d’å ~ò ê (ï ~<—> ° d ONLN dŸå ¢ò ¿ )$short ° d ONLN d‚å ¸òV )ZfSystemVRefNum; ° d ONLN dÚó ~£å († ~-} EnvironmentSetupPB, *EnvironmentSetupPBPtr;
° d ONLN d ≥ ~æ ◊ *Field descriptions
° d ONLN d3¡ ~Õ fi *fCallBackProcPtr ° d ONLN dD¡Õ )ê>A pointer to the Installer’s dispatch routine. You’ll need to ° d ONLN dÉÕŸ * 9pass this field as a parameter to Installer function glue ° d ONLN dΩŸÂ5 * routines. ° d ONLN d«Ì ~˘ Ã (ˆ ~
fTargetFSSpec ° d ONLN d’Ì˘ )ê=Contains the Installer’s suggested target folder information. ° d ONLN d˘ * =You can choose to override this suggestion by changing any of ° d ONLN dRZ * the fields in the ° d ONLN ddZ~ )LFSSPec ° d ONLN dj~» )$ structure. If the ° d ONLN d~ t (useDiskTargetMode ° d ONLN dèt
)f$ flag is specified in the preference ° d ONLN d¥ )_ (&resource, only the ° d ONLN d« _)â )QvRefNum ° d ONLN dŒ â)Ø )*
field of ° d ONLN dÿ Ø)˝ )&
fTargetFSSpec ° d ONLN d ˝)* )N is used by ° d ONLN dÒ)5K (2the Installer. ° d ONLN d = ~I “ (F ~fSystemVRefNum ° d ONLN d=I" )êThe ° d ONLN d="Iv )fSystemVRefNum ° d ONLN d!=vI˘ )T field contains the Installer’s ° d ONLN dAIU. (R=recommended System Folder volume. You can choose to override ° d ONLN dUa * <this suggestion by changing the value passed. This field is ° d ONLN dºamx * ignored when using the ° d ONLN d”axmfi )juseDiskTargetMode ° d ONLN d‰afim) )f flag because the ° d ONLN dˆmy
(v7system disk must always be the same as the target disk. ˇ d ˇ ˇˇˇˇ d
d , Palatino
. +~-C H A P T E R 3 , Helvetica
(Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ú27
$ ° d ONLN d Q ~ y ( o ~Packages and Atoms " ° ∂ 40 ° ∂ ° ∂
° d ONLN d ~*t *∏5This chapter describes how to use packages and atoms.
° d ONLN d IB 6V ˙ (Q 6About Packages (‘inpk’) " ° ∂ V 4V0 ° ∂ ° ∂
° d ONLN d a[ ~gÅ +H:The package is added to the Custom Install list using the ,
Courier ° d ONLN d õ[Ågœ (dÅ
AddCustomItem ° d ONLN d ®[œg! )N rule clause, and if ° d ONLN d Ωg ~s (p ~]selected when clicking the Install or Remove button, will be added to the list of packages to ° d ONLN ds ~í * @install/remove. For an Easy Install, the Installer rule clause ° d ONLN d[sí‘ (|í AddPackages ° d ONLN dfs‘& )B is used to build up ° d ONLN d{ ~ã (à ~Ythe list of packages that the Installer will use to perform the bulk of the installation.
° d ONLN d‰º ~» +HZPackages group atoms to make scripting easier, and to provide the hierarchical list in the ° d ONLN d?» ~‘ * ZCustom Install dialog. The package contains a list of those atoms and other packages that ° d ONLN dö‘ ~‡Î * Oshould be installed or removed when the parent package is installed or removed.
° d ONLN dÏÙ ~I *" Using Packages with Easy Install " ° ∂ |0 ° ∂ ° ∂
° d ONLN d
~+ *aOne of the goals of the Easy Install rules is to specify the packages that will be installed when ° d ONLN do ~ ˜ * Wthe user clicks the Install button. Your Easy Install rules should eventually call the ° d ONLN d« ~+ * [AddPackages rule clause to specify the packages, and ultimately the atoms, to be installed. ° d ONLN d$+ ~7# * `During an easy installation, the Installer is only concerned with the parts list and the restart ° d ONLN dÖ7 ~C * [flag. The other fields are currently used only in the Custom Install and Remove interface.
° d ONLN d‚W ~fÆ *"-Using Packages with Custom Install and Remove " ° ∂ e |e0 ° ∂ ° ∂
° d ONLN dj ~v *[Packages are the foundation for the selectable items the user can choose from in the Custom ° d ONLN dlv ~Ç! * ^Install list. Packages are included at the top-level of the list by calling the AddCustomItem ° d ONLN dÀÇ ~é+ * `rule clause from the Custom Install rules. The specified packages will then be displayed in the ° d ONLN d,é ~ö * Ylist with any nested packages (with their showsOnCustom flag set) shown as selectable sub ° d ONLN dÖéö (ó- ° d ONLN dÜö ~¶. (£ ~cpackages. It is then up to the user to select the desired packages and click the Install or Remove ° d ONLN dͶ ~≤ ù * button. ° d ONLN dÚ∫ ~Δ *[To aid the user in deciding which items to select, an optional Get Info-style window can be ° d ONLN dNΔ ~“% * `supplied by scriptwriter that provides the icon, total size, version, date and information text. ˇ> d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ], ( Z ~^To enable the Get Info window for the item, you need only to create a Package Comment resource ° d ONLN d _ ] ~ iG * -(‘icmt’) and reference this from the package.
° d ONLN d ç } ~ å *"Atom Execution Order " ° ∂ ã | ã0 ° ∂ ° ∂
° d ONLN d ¢ ê ~ ú% *^Once the user clicks the Install or Remove button all specified packages are decomposed into a ° d ONLN d ú ~ ® * `flat list of atoms. Therefore, the order the Installer executes the atoms is unrelated to their ° d ONLN db ® ~ ¥ * `position in the package’s part list. Prior to installation the Installer groups File, Resource, ° d ONLN d√ ¥ ~ ¿+ * ^Font, ResMerge, and Folder Atoms based on the source disk they reference. Those atoms that do ° d ONLN d" ¿ ~ Ã≈ * Jnot need source disks (atoms that delete on install) are grouped together. ° d ONLN do ‘ ~ ‡“ *MFor each source disk the Installer executes the atoms in the following order: ,
Zapf Dingbats
° d ONLN dΩ Í ~ Û Ö *n
° d ONLN dø Ë ê Ù – )
Folder Atoms.
° d ONLN dÕ ˛ ~ Ö ( ~n
° d ONLN dœ ¸ ê$ )YFile Atoms. This allows you to overwrite a file copied with a Folder Atom on the same or ° d ONLN d) ê Ì * previous source disk.
° d ONLN d? ~' Ö (% ~n
° d ONLN dA ê(( )[ResMerge Atoms. This allows you to add or replace additional resources to a file copied on ° d ONLN dù( ê4# * !the same or previous source disk.
° d ONLN dø> ~G Ö (E ~n
° d ONLN d¡< êH+ )]Resource Atoms. This allows you to add or replace a resource in a file copied with a Folder, ° d ONLN d H êTò * :File or ResMerge Atom on the same or previous source disk.
° d ONLN dZ^ ~g Ö (e ~n
° d ONLN d\\ êh Δ ) Font Atoms. ° d ONLN dhp ~| (y ~]Although the Installer will consistently order the atoms of a specific type, the scriptwriter ° d ONLN dΔ| ~à) * \should never depend on this ordering, except for Action Atoms which are always guaranteed to ° d ONLN d#à ~î( * 'be ordered by their ‘inaa’ resource ID. ° d ONLN dMú ~® *]To ensure that the source disks will always be copied in the same order, include a Disk Order ° d ONLN d´® ~¥ * !resource (‘indo’) in your script.
— ı )S'inpk' ° d ONLN d ı∫ )$- resource type. Its template is shown below. ° d ONLN dA ~" ® ( ~#define ° d ONLN dI ¥" ¸ )6 PackageFlags ° d ONLN d\z"Ä )Δ\ ° d ONLN d_! ê- ∫ (* êboolean ° d ONLN dg! Δ-ò )6#doesntShowOnCustom, showsOnCustom; ° d ONLN dã!û-§ )ÿ\ ° d ONLN dé, ê8 ∫ (5 êboolean ° d ONLN dñ, Δ8V )6notRemovable, removable; ° d ONLN d∞,z8Ä )¥\ ° d ONLN d≥7 êC ∫ (@ êboolean ° d ONLN dª7 ΔCÄ )6 forceRestart, dontForceRestart; ° d ONLN d€7åCí )Δ\ ° d ONLN dfiB êN ÿ (K ê fill bit[13] ° d ONLN dÎB ÍN> )Z/* Reserved */ ° d ONLN d˙X ~d à (a ~
type 'inpk' { ° d ONLN d c êo ¿ + switch { ° d ONLN dn ¢z +
case format0: ° d ONLN d%y ¥Ö + key integer = 0; ° d ONLN d9yVÖ˛ )¢ /* Package Format version */ ° d ONLN dYÑ ¥ê (ç ¥
PackageFlags; ° d ONLN dkÑVê» )¢/* Package Flags */ ° d ONLN dÇè ¥õ (ò ¥unsigned integer; ° d ONLN dóèVõ )¢ /* Package Comment Rsrc ID */ ° d ONLN d∏ö ¥¶ (£ ¥unsigned longint; ° d ONLN dÕöV¶¬ )¢/* Package Size */ ° d ONLN d„• ¥± (Æ ¥EvenPaddedString; ° d ONLN d¯•V±¬ )¢/* Package Name */ ° d ONLN d∞ ¥º§ (π ¥(unsigned integer = $$CountOf(PartsList); ° d ONLN d;ª ¥«8 * wide array PartsList { ° d ONLN dSªV«∂ )¢/* Parts List */ ° d ONLN dgΔ ¥“ ¸ (œ ¥ RsrcType; ° d ONLN dxΔV“∞ )¢/* Part Type */ ° d ONLN dã— ¥› (⁄ ¥
° d ONLN d Q ¥ ] ¿ ( Z ¥}; ° d ONLN d \ ê h ú ( e ê}; ° d ONLN d g ~ s ä ( p ~};
° d ONLN d
É ~ é ‘ *Flag descriptions
° d ONLN d ë ~ ù> * showsOnCustom/doesntShowOnCustom ° d ONLN d = ë> ù@ )¿ ° d ONLN d @ ú ®$ ( •;Determines if the package should be displayed in the Custom ° d ONLN d | ® ¥B *
Install list. ° d ONLN d ã º ~ » ( ≈ ~removable/notRemovable ° d ONLN d £ º » )ê8Determines if the package should be added to the list of ° d ONLN d ‹ » ‘' * ;packages to be removed when the user has clicked the Remove ° d ONLN d ‘ ‡& * :button. When used with the showsOnCustom flag, determines ° d ONLN dS ‡ Ï * =if the package is selectable in the Custom Remove list. Note ° d ONLN dë Ï ¯Ñ * that you must also set the ° d ONLN d¨ ÏÑ ¯ )vdeleteWhenRemoving ° d ONLN dæ Ï ¯$ )l flag on any ° d ONLN dÀ ¯ (;File, Resource or Font Atoms that are to be removed and you ° d ONLN dF *
must set the ° d ONLN dFà )8 actOnRemove ° d ONLN d à- )B% flag in any Action Atoms that are to ° d ONLN dE : (
be called. ° d ONLN dQ$0 *8To include an package as a selectable item within Custom ° d ONLN dä0< * 8Remove, it is necessary to also include the package as a ° d ONLN d√<H( * @selectable item in Custom Install. There is no option to display ° d ONLN dHT * ;a package as a selectable item in Custom Remove, but not in ° d ONLN d@T` * ;Custom Install. You may however choose to do nothing if the ° d ONLN d|`l& * >package is a selected item within Custom Install, and only act ° d ONLN dªlx$ * ;on that selected package during Custom Remove, but this may ° d ONLN d˜xÑw * be confusing to the user. ° d ONLN då ~ò, (ï ~ forceRestart/dontForceRestart ° d ONLN d0ó£- +ê BDetermines if the Installer should force the user to restart their ° d ONLN ds£Ø' * <Macintosh after installing or removing this package when the ° d ONLN d∞ØªÛ * 4currently active System Folder is a target. Use the ° d ONLN dª«V * forceRestart ° d ONLN dÒªV« )H/ flag if the installation requires rebooting to ° d ONLN d!«” (–:gain functionality, or if the package makes changes to the ° d ONLN d\”flE * System file.
° d ONLN diÈ ~Ù ◊ (Ò ~Field descriptions
° d ONLN d}˜ ~ *Package Comment Rsrc ID ° d ONLN dñ +ê ;The resource ID of a package comment resource that displays ° d ONLN d“" * @the package’s size, date, version and a brief description of its ° d ONLN d&( * >contents or what it does. It’s recommended that every package ° d ONLN dR&2 * =shown in the Custom Install list have a comment resource. If ° d ONLN dê2>$ * =you do not wish to provide a package comment, place a zero in ° d ONLN dŒ>J+ * Bthis field. There are two types of comment resources. The first, ° d ONLN dJV * ?an ‘icmt’ resource, provides basic information in one resource. ° d ONLN dRVb * 9The newer ‘inpc’ resource supports the RAM Size field and ° d ONLN dåbn˘ * 5references a ‘TEXT’ resource that allows up to 32K of ° d ONLN d¬nzà * information text. (2-bytes) ° d ONLN dflÇ ~é à (ã ~
Package Size ° d ONLN dÌÇé$ )ê=The size of all atoms and packages contained in this package. ° d ONLN d,éö+ * >This value is used to display in the comment window as well as ° d ONLN dkö¶ * 7provide the estimated selection size provided in Custom ° d ONLN d£¶≤! * @Install. The Installer does not use this field to determine the ° d ONLN d‰≤æ! * =actual disk space requirements of the target hard disk during ° d ONLN d "æ - * ?preflighting. Individual atom sizes are summed to determine if ° d ONLN d b ÷Ú * 5sufficient target disk space is available. (4-bytes) ˇ4 d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ] Δ ( Z ~ Package Name ° d ONLN d Q Δ ] » )H ° d ONLN d Q ] )H;The name to be displayed in the Custom Install list. (even ° d ONLN d I Q ] ( Z- ° d ONLN d J ] iq ( fpadded Pascal string) ° d ONLN d a q }- *@If the Package Name field is a single dash character (-), a gray ° d ONLN d ¢ } â) * @horizontal line appears in the list of packages. This dash line ° d ONLN d „ â ï" * Ais similar to the one found for menu resources. This line can be ° d ONLN d% ï °# * >used to separate the items which can be installed into logical ° d ONLN dd ° ≠ * >groups. If a package is used just for displaying a separation ° d ONLN d£ ≠ π¿ * *line, all of the other fields are ignored. ° d ONLN d– ¡ Õ∏ *$Below is a sample gray-line package: ° d ONLN d¯ ’ · *r ° d ONLN d˘ ’ ·‰ )#esource 'inpk' (1, "dashed line") { ° d ONLN d ·2 Ìh + format0 { ° d ONLN d* ÏV ¯™ +$ showsOnCustom, ° d ONLN d; ˜V§ *
notRemovable, ° d ONLN dKVº * dontForceRestart, ° d ONLN d_
Vb * 0, ° d ONLN db
z˛ )$/* Pkg Cmnt Rsrc ID */ ° d ONLN d{V$b (!V0, ° d ONLN d~z$Ê )$/* Package size */ ° d ONLN dì#V/n (,V"-", ° d ONLN dò#z/Ê )$/* Package Name */ ° d ONLN d≠.V:‡ (7V{} /* empty brackets */ ° d ONLN dΔ92E8 (B2} ° d ONLN d»DP (M}; ° d ONLN dÀW ~c ¥ (` ~ Part List ° d ONLN d‘W ¥c ∂ )6 ° d ONLN d÷Wc )Z7The type and resource ID of each part contained in this ° d ONLN dcofl * 0package. (4-bytes + 2-bytes for each list item)
° d ONLN ddò ~§ˇ +HTVisible packages should reference one of two comment resources to provide additional ° d ONLN dπ§ ~∞ * [information to the user about the packages they might want to install or remove. The older ° d ONLN d∞ ~º * \‘icmt’ is supported, but cannot specify the RAM Size field. The new ‘inpc’ comment resource ° d ONLN drº ~»& * _must reference a ‘TEXT’ resource that contains the text to display at the bottom of the package ° d ONLN d“» ~‘b * 1info window. Both templates are described below.
type 'inpc' { ° d ONLN dBV˛ )ÿ * New Custom Item comment */ ° d ONLN da
¢ “ ( ¢switch { ° d ONLN dm ¥$ +
case format1: ° d ONLN d# Δ/& + key integer = 1; ° d ONLN dí#V/ )ê /* Custom Item Format version */ ° d ONLN d∑. Δ:D (7 Δunsigned hex longint; ° d ONLN dÕ.V:⁄ )ê/* Custom Item Date */ ° d ONLN dË9 ΔED (B Δunsigned hex longint; ° d ONLN d˛9VEÏ )ê/* Custom Item Version */ ° d ONLN d D ΔPD (M Δunsigned hex longint; ° d ONLN d2DVP" )ê"/* Custom Item RAM Requirements */ ° d ONLN dYO Δ[ (X ΔrsrcID; ° d ONLN dfOV[Ï )ê/* Custom Item Icon ID */ ° d ONLN dÑZ Δf (c ΔrsrcID; ° d ONLN dëZVf" )ê"/* Custom Item Desc. ('TEXT' ID)*/ ° d ONLN d∂e ¢q Æ (n ¢}; ° d ONLN dπp ~| ä (y ~};
° d ONLN dºå ~ó ◊ *Field descriptions
° d ONLN d–ö ~¶ fi *Custom Item Date ° d ONLN d‡ö fi¶ ‡ )` ° d ONLN d‚ö¶ )0;The release date of the package. The value is specified in ° d ONLN d ¶≤ı * 6seconds since January 1, 1904. The Installer uses the ° d ONLN dU≤æ * <IUDateString toolbox call to get the string to display. See ° d ONLN díæ ã * Inside Macintosh Volume II ° d ONLN d¨æã à )}, page 377 and ° d ONLN dªæà )AInside Macintosh ° d ONLN dà ÷: (” Volume I, ° d ONLN d’ :÷ì ), page 504. (4-bytes) ˇƒ d ˇ ˇˇˇˇ d
bytes) ° d ONLN dÈ ~$ (! ~Custom Item Icon ID ° d ONLN d¸ $ Ú )r ° d ONLN d˛$á ) The ID of the appropriate ° d ONLN dá$ )yICON, ICN#, icl4 and/or ° d ONLN d0$0& (-icl8 ° d ONLN d4$&0$ ): resources. The ID must be 1024 or greater (IDs below this ° d ONLN do0< (9=range are reserved). If the script contains these icons, the ° d ONLN d≠<H * <appropriate one is displayed in the upper left corner of the ° d ONLN dÍHT¬ * &package information window. (2-bytes) ° d ONLN d\ ~h (e ~Custom Item Description ° d ONLN d(\h
)ä ° d ONLN d+gs* + @The ID of a ‘TEXT’ resource containing the text to appear in the ° d ONLN dls) * =comment section of the package information window. It should ° d ONLN d™ã * :describe the package and provide any information that will ° d ONLN dÂãó * =help the user decide if installing or removing the package is ° d ONLN d#ó£$ * @appropriate. Styled text is not currently supported. (2-bytes)
type 'icmt' { ° d ONLN d°‹ ¢Ë +$ unsigned hex longint; ° d ONLN d∑‹2Ëû )ê/* Release Date */ ° d ONLN dÃÁ ¢Û ( ¢unsigned hex longint; ° d ONLN d‚Á2Û§ )ê/* Version Number*/ ° d ONLN d¯Ú ¢˛ à (˚ ¢RsrcID; ° d ONLN dÚ2˛Ä )ê
/* Icon ID */ ° d ONLN d˝ ¢ ( ¢EvenPaddedString; ° d ONLN d)˝2 Œ )ê/* Package Comment Text */ ° d ONLN dD ~ ä ( ~};
° d ONLN dG$ ~/ ◊ *Field descriptions
° d ONLN d[2 ~> Δ * Release Date ° d ONLN dg2 Δ> » )H ° d ONLN di2> )H;The release date of the package. The value is specified in ° d ONLN d•>Jı * 6seconds since January 1, 1904. The Installer uses the ° d ONLN d‹JV * <IUDateString toolbox call to get the string to display. See ° d ONLN dVbã * Inside Macintosh Volume II ° d ONLN d3Vãbà )}, page 377 and ° d ONLN dBVÃb )AInside Macintosh ° d ONLN dSbn: (k Volume I, ° d ONLN d\b:nì ), page 504. (4-bytes) ° d ONLN drv ~Ç ÿ ( ~Version Number ° d ONLN dÇvÇ, )ê?The version number of this package. The Installer can decipher ° d ONLN d¬Çéj * two version formats: ° d ONLN dÿñ¢ñ * Binary coded decimal number. ° d ONLN dÙññ¢% )à! The ones digit is the secondary ° d ONLN d¢Æ% (´Crevision (0 to 9), the tens digit is the primary revision (0 to 9), ° d ONLN dZÆ∫ * 7and all greater digits make up the version number. For ° d ONLN dí∫Δ * ?example, 100 is version 1.0, 290 is version 2.9, 605 is version ° d ONLN d“Δ“ * <6.0.5, and 5704 is version 57.0.4. The Installer knows this ° d ONLN d “fi * <format because it will always be less than 10000. (4-bytes) ˇû d ˇ ˇˇˇˇ d
° d ONLN d Q ]∞ ( Z#‘vers’ resource hexadecimal number. ° d ONLN d # Q∞ ] )¢ See the definition of ° d ONLN d ; ] iÌ ( f4‘Version’ in the “InstallerTypes.r” file. (4-bytes) ,
Courier ° d ONLN d p q ~ } ® ( z ~Icon ID ° d ONLN d w q ® } ™ )* ° d ONLN d y q }á )fThe ID of the appropriate ° d ONLN d ì qá } )yICON, ICN#, icl4 and/or ° d ONLN d ´ } â& ( Üicl8 ° d ONLN d Ø }& â$ ): resources. The ID must be 1024 or greater (IDs below this ° d ONLN d Í â ï ( í=range are reserved). If the script contains these icons, the ° d ONLN d( ï ° * <appropriate one is displayed in the upper left corner of the ° d ONLN de ° ≠∂ * "Package Comment window. (2-bytes) ° d ONLN dà µ ~ ¡ ˆ ( æ ~Package Comment Text ° d ONLN dú µ ˆ ¡ ¯ )x ° d ONLN dû µ ¡' )<The text which appears in the comment section of the Package ° d ONLN d€ ¡ Õ * 8Comment. It should describe the package and provide any ° d ONLN d Õ Ÿ * ;information that will help the user decide if installing or ° d ONLN dP Ÿ Â * 9removing the package is appropriate. (even-padded Pascal ° d ONLN dä Â Ò, * string)
° d ONLN dí 6 › ( 6About the File Atom " ° ∂ 4 0 ° ∂ ° ∂
° d ONLN d¶" ~. +H`The File Atom should be used to copy or delete one or both forks of a file. Two versions of the ° d ONLN d. ~: * ]File Atom script resource are understood by Installer 4.0, but it is recommended that you use ° d ONLN de: ~F * format version 1. ° d ONLN dwN ~ZÌ *RThe File Atom provides the following major features for copying or deleting files: ,
Zapf Dingbats
° d ONLN d d ~m Ö *n
° d ONLN dÃb ênk )3Ability to update a file only if it already exists.
° d ONLN d x ~Å Ö ( ~n
° d ONLN dv êÇ0 )%Ability to preserve an existing file.
° d ONLN d(å ~ï Ö (ì ~n
° d ONLN d*ä êñ )]Ability to preserve a newer file based on its creation date, ‘vers’ 1 resource or custom code ° d ONLN dàñ ê¢ æ *
you write.
° d ONLN dì¨ ~µ Ö (≥ ~n
° d ONLN dï™ ê∂T ),Decompression of a file during installation.
° d ONLN d¬¿ ~… Ö (« ~n
° d ONLN dƒæ ê ! )YAutomatically unlock the file before replacing or deleting, and/or lock the file when the ° d ONLN d ê÷ ˝ * installation is finished.
° d ONLN d8‡ ~È Ö (Á ~n
° d ONLN d:fi êÍ• )?Install a file that has been split among multiple source disks. ° d ONLN dzÚ ~˛ (˚ ~[If you are simply copying hundreds of uncompressed files and do not wish to create separate ° d ONLN d÷˛ ~
µ * EFiles Atoms for each, you might be able to use a Folder Atom instead.
° d ONLN d " 66 (1 6 Using the File Atom (‘infa’) " ° ∂ 6 460 ° ∂ ° ∂
° d ONLN d9; ~G +H`The new version of the File Atom provides for large source files to be split across installation ° d ONLN döG ~S˛ * Zdisks, then joined into one file on the target disk during the installation. In addition, ° d ONLN dıS ~_ * [compressed source files can be decompressed during the installation using an Atom Extender.
° d ONLN dQs ~Ç* *"Comparing Files by Version " ° ∂ Å |Å0 ° ∂ ° ∂
° d ONLN dlÜ ~í *\Two new fields in the File Atom allow the scriptwriter to compare the source and target file ° d ONLN d…í ~û# * ausing their version number, instead of only using their creation date. The first field holds the ° d ONLN d+û ~™ * Ysource file’s version number, and the second field holds the resource ID of a new Version ° d ONLN dÖ™ ~∂. * aCompare (‘invc’) script resource. The Version Compare script resource allows the scriptwriter to ° d ONLN dÁ∂ ~¬√ * Kcall a code resource that calculates the version number of the target file. ° d ONLN d 4 ~÷ *[To compare the newness of the target and source using the old creation date method, use the ° d ONLN d ê÷ ~‚ ¸ * useSrcCrDateToCompare ° d ONLN d •÷ ¸‚ )~B flag. To compare using the version number in the target’s ‘vers’ ˇ* d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ] ˆ ( Z ~ID=1 resource then use the ,
Courier ° d ONLN d Q ˆ ]n )xuseVersProcToCompare ° d ONLN d / Qn ] )x) flag and place a 0 (zero) in the Version ° d ONLN d Y ] ~ i ( f ~YCompare Rsrc ID field. If the version number is stored somewhere besides the ‘vers’ ID=1 ° d ONLN d ≥ i ~ u * \resource then you’ll need to create and attach a Version Compare script resource to the File ° d ONLN d u ~ Å ö * Atom. ° d ONLN d â ~ ï À *Using either the ° d ONLN d' â À ïI )MuseSrcCrDateToCompare ° d ONLN d< âI ïV )~ or ° d ONLN d@ âV ïŒ )
useVersProcToCompare ° d ONLN dT ⌠ï )x flag presents the ° d ONLN dg ï ~ °- ( û ~fidentical interface to the user if the source file is older than the target file. See the description ° d ONLN dŒ ° ~ ≠ õ * of the ° d ONLN d’ ° õ ≠ ) leaveAloneIfNewer ° d ONLN dÊ ° ≠ø )f+ flag in the “File Atom Reference” section.
° d ONLN d ¡ ~ –X ( à ~#Using Split Sources with File Atoms " ° ∂ œ | œ0 ° ∂ ° ∂
° d ONLN d6 ‘ ~ ‡! *bThe new ‘infa’ script resource contains a source list that holds zero or more references to source ° d ONLN dô ‡ ~ Ï * dfiles. If the original source file must be split into smaller files, an entry for each split source ° d ONLN d˛ Ï ~ ¯$ * `piece should be placed into the source list. Each entry contains information about the location ° d ONLN d_ ¯ ~% * eof the source file (‘infs’ ID), the target size of the resource fork piece and the target size of the ° d ONLN d≈ ~ Δ * data fork piece. ° d ONLN d÷ ~$- *cEach target size field must contain the exact size the source piece will appear in the target file. ° d ONLN d;$ ~0! * ]If the piece is being decompressed with an Atom Extender during installation, then this field ° d ONLN dô0 ~< * `must contain the uncompressed size of the piece. If only one fork is requested to be copied, the ° d ONLN d˙< ~H* * gtarget size field of the other fork is ignored. Place a zero in a fork’s target size field if the fork ° d ONLN dbH ~T * contains no data.
° d ONLN dt^ ~i ö *NOTE
° d ONLN dyl ~x' *cThe order of the entries in the source list is important. Each piece will be written to the target ° d ONLN d›x ~ÑP * 2file in the same order as it appears in the list. ,
Zapf Dingbats
° d ONLN dzPÉW )“u
° d ONLN dò ~ßj (£ ~$Using Atom Extenders with File Atoms " ° ∂ ¶ |¶0 ° ∂ ° ∂
° d ONLN d6´ ~∑
*UUsing Atom Extenders with the new File Atom (Format 1) allows scriptwriters to easily ° d ONLN då∑ ~√# * \decompress files that have been compressed on the source installation disk. Attach the Atom ° d ONLN dÈ√ ~œ˙ * XExtender to the File Atom file by entering the ID of the ‘inex’ script resource into the ° d ONLN dBœ ~€) * cappropriate field in the ‘infa’. The code resource referenced from the ‘inex’ script resource will ° d ONLN d¶€ ~Á * [be called at the desired point in the installation so it can read the compressed file data, ° d ONLN dÁ ~Ûk * 6decompress the data, then write it to the target file.
° d ONLN d9˝ ~ ö *NOTE
° d ONLN d> ~$ *^You should never create a source file that has a compressed resource fork, because any attempt ° d ONLN dù ~# * \to access the resource fork by the Finder or other application may crash the Macintosh. The ° d ONLN d˙# ~/\ * %rsrcForkInRsrcFork/rsrcForkInDataFork ° d ONLN d #\/# )fi+ flag has been added to designate where the ° d ONLN d K/ ~; (8 ~"resource fork is stored. Use the ° d ONLN d m/ ;w )çrsrcForkInDataFork ° d ONLN d /w; )l flag when copying a compressed ° d ONLN d ü; ~Gπ (D ~Kresource fork that is stored in the data fork of the source file. Use the ° d ONLN d Í;πG% (DπrsrcForkInRsrcFork ° d ONLN d ˝G ~Sa (P ~2flag when copying a non-compressed resource fork.
° d ONLN d
/IaRh )„u
° d ONLN d
1[ ~g# (d ~^When the Installer is preparing to install, each File Atom is expanded into one or more parts. ° d ONLN d
ëg ~s) * ^As each part is installed, the Atom Extender attached to the original File Atom will be called ° d ONLN d
s ~. * dfor each part. When only one source file is specified there is one part for each fork being copied. ° d ONLN d V ~ã * ]When split source pieces are specified there is one part for each fork being copied from each ° d ONLN d ¥ã ~ó ô * piece. ° d ONLN d ªü ~´ *UThe goal of the new File Atom and Atom Extender is to provide compatibility with most ° d ONLN d ´ ~∑ * Xpopular compressed source file configurations. Several configurations are listed below. ˇí d ˇ ˇˇˇˇ d
° d ONLN d Q ê ]* )]The simplest source file configuration is for each compressed fork to be placed into the data ° d ONLN d ` ] ê i! * Zfork of two separate files. The Installer will call the Atom Extender separately for each ° d ONLN d ª i ê u ¶ * fork.
° d ONLN d ¡ ~ à Ö ( Ü ~n
° d ONLN d √ } ê â% )]Another source file configuration places both forks into the same data fork of a source file, ° d ONLN d! â ê ï- * [with a header describing the format of the data. The Atom Extender will be called once for ° d ONLN d} ï ê ° * [each fork copied, but will be responsible for finding, reading and writing the correct data ° d ONLN dŸ ° ê ≠) * Yfor the specified fork. The Atom Extender parameter block will provide information about ° d ONLN d3 ≠ ê π
* which fork is being copied.
° d ONLN dO √ ~ Ã Ö ( ~n
° d ONLN dQ ¡ ê Õ )YAn “Archived” source file configuration contains multiple compressed files (and forks) in ° d ONLN d´ Õ ê Ÿ% * \one source file. One File Atom must be created for each target file being copied, with each ° d ONLN d Ÿ ê  * Zreferring to the same source file (‘infs’). The Atom Extender parameter block will contain ° d ONLN dc  ê Ò$ * Xinformation about the current file (and fork) being copied, with which the Atom Extender ° d ONLN dº Ò ê ˝ * Vwill find, read, decompress and write the proper target file’s data. Our InstaCompOne ° d ONLN d ˝ ê d * -Atom Extender is an example of this approach. ° d ONLN dA ~ ˚ ( ~UFor those source configurations that cannot be accommodated by the built-in routines, ° d ONLN dó ~) * [scriptwriters can use the supplied parameter block to perform the copy by themselves. This ° d ONLN dÛ) ~5Ä * 8strategy should only be taken when absolutely necessary.
° d ONLN d,I ~X? *" Installing a Custom Folder Icon " ° ∂ W |W0 ° ∂ ° ∂
° d ONLN dM\ ~h *^The File Atom can easily be used to set the custom icon of any folder on the target disk. The ° d ONLN d¨h ~t * _Installer notices if the scriptwriter is copying the special invisible “Icon\n” file, and if so ° d ONLN d t ~Äñ * ?automatically sets the userCustomIcon bit on its parent folder. ° d ONLN dLà ~î¡ *GThere are several key points to remember when installing a custom icon:
° d ONLN dîû ~ß Ö *n
° d ONLN dñú ê®Ì )PSince the Installer does not remove the special “Icon\n” file correctly, use the ,
Courier ° d ONLN dÁ® ê¥ * dontDeleteWhenRemoving ° d ONLN d˝®¥í )Ñ flag to prevent its removal.
° d ONLN d æ ~« Ö (≈ ~n
° d ONLN d º ê»ä )<It’s polite to preserve an existing custom icon, so use the ° d ONLN dZºä»“ )˙ copyIfUpdate ° d ONLN dfº“»Í )H flag.
° d ONLN dm“ ~€ Ö (Ÿ ~n
° d ONLN do– ê‹* )_The Installer will install the custom icon even if the directory is the root level of the hard ° d ONLN dœ‹ êË- * [disk. We discourage scriptwriters from recommending the root level of the hard disk as the ° d ONLN d+Ë êÙt * 7target folder, but user’s can select it if they choose.
° d ONLN dc 6 · ( 6File Atom Reference " ° ∂ 4 0 ° ∂ ° ∂
° d ONLN dw% ~1ÿ +HQThis section describes the resource description of the ‘infa’ resource, format 1.
° d ONLN d…E 6U Ω (Q 6Resource Description " ° ∂ U 4U0 ° ∂ ° ∂
° d ONLN dfib ~n ® +H#define ° d ONLN dÊb ¥n )6
fileAtomFlags ° d ONLN d b
n (k
\ ° d ONLN d m ¢y à (v ¢boolean ° d ONLN d m ÍyÏ )H+dontDeleteWhenRemoving, deleteWhenRemoving; ° d ONLN d <m
y (v
\ ° d ONLN d @x ¢Ñ à (Å ¢boolean ° d ONLN d Ix ÍÑ )H/dontDeleteWhenInstalling, deleteWhenInstalling; ° d ONLN d yx
Ñ (Å
\ ° d ONLN d }É ¢è à (å ¢boolean ° d ONLN d ÜÉ ÍèD )HdontCopy, copy; ° d ONLN d †É
è (å
\ ° d ONLN d §é ¢ö ‰ (ó ¢ fill bit[3] ° d ONLN d ∞é Íö> )H/* Reserved */ ° d ONLN d é
ö (ó
\ ° d ONLN d Œô ¢• à (¢ ¢boolean ° d ONLN d ◊ô Í•‘ )H'dontIgnoreLockedFile, ignoreLockedFile; ° d ONLN d
ô
• (¢
\ ° d ONLN d
§ ¢∞ Ã (≠ ¢boolean ° d ONLN d
§ Í∞∂ )H"dontSetFileLocked, setFileLocked; ° d ONLN d
5§
∞ (≠
\ ° d ONLN d
9Ø ¢ª à (∏ ¢boolean ° d ONLN d
BØ Íª¯ )H-useSrcCrDateToCompare, useVersProcToCompare; ° d ONLN d
pØ
ª (∏
\ ° d ONLN d
t∫ ¢Δ Ã (√ ¢boolean ° d ONLN d
}∫ ÍΔ§ )H srcNeedExist, srcNeedNotExist; ° d ONLN d
¢∫
Δ (√
\ ° d ONLN d
¶≈ ¢— à (Œ ¢boolean ° d ONLN d
Ø≈ Í—⁄ )H(rsrcForkInRsrcFork, rsrcForkInDataFork; ° d ONLN d
⁄≈
— (Œ
\ ° d ONLN d
‹– ~‹ Ñ (Ÿ ~ ° d ONLN d
fl– ¢‹ à )$boolean ° d ONLN d
Ë– Í‹» )H%updateEvenIfNewer, leaveAloneIfNewer; ° d ONLN d –
° d ONLN d Q ¢ ] Ã ( Z ¢boolean ° d ONLN d Q Í ]ò )H updateExisting, keepExisting; ° d ONLN d - Q
] ( Z
\ ° d ONLN d 1 \ ¢ h à ( e ¢boolean ° d ONLN d : \ Í h™ )H copyIfNewOrUpdate, copyIfUpdate; ° d ONLN d ` \
h ( e
\ ° d ONLN d d g ¢ s à ( p ¢boolean ° d ONLN d m g Í sh )HnoRsrcFork, rsrcFork; ° d ONLN d ã g
s ( p
\ ° d ONLN d è r ¢ ~ Ã ( { ¢boolean ° d ONLN d ò r Í ~b )HnoDataFork, dataFork ° d ONLN d ± ë ~ ù Ã ( ö ~
type 'infa' { ° d ONLN d ¡ ú ¢ ® “ +$ switch { ° d ONLN d Õ ß ¥ ≥ +
case format1: ° d ONLN d fl ≤ Δ æ& + key integer = 1; ° d ONLN d Ù ≤z æ )¥/* File Atom version */ ° d ONLN d Ω Δ … ( Δ ΔfileAtom1Flags; ° d ONLN d$ Ωz …¯ )¥/* File Atom Flags */ ° d ONLN d> » Δ ‘, ( — Δunsigned longInt; ° d ONLN dT »z ‘" )¥ /* Total Target File Size */ ° d ONLN du ” Δ fl, ( ‹ Δunsigned integer; ° d ONLN dã ”z fl" )¥ /* Finder Attribute Flags */ ° d ONLN d¨ fi Δ Í ( Á Δ fileSpecID; ° d ONLN dæ fiz Ͳ )¥/* Tgt file spec ID */ ° d ONLN dŸ È Δ ıt ( Ú Δ integer = $$CountOf (Pieces); ° d ONLN d˜ Èz ı( )¥ /* Number of Source Pieces */ ° d ONLN d Ù Δ 8 ( ˝ Δwide array Pieces { ° d ONLN d2 ˇ ÿ + fileSpecID; ° d ONLN dB ˇh Ê )ê/* Source File Spec*/ ° d ONLN d]
ÿ> ( ÿunsigned longInt; ° d ONLN dq
h( )ê /* Target Data Fork Part Size */ ° d ONLN dó ÿ!> ( ÿunsigned longInt; ° d ONLN d´h!( )ê /* Target Rsrc Fork Part Size */ ° d ONLN d– Δ, “ () Δ}; ° d ONLN d◊+ Δ7, * unsigned longint; ° d ONLN dÏ+h7
)¢/* Source Version Number */ ° d ONLN d 6 ΔB (? ΔrsrcID; ° d ONLN d6hB )¢ /* Version Compare Rsrc ID */ ° d ONLN d<A ΔM (J ΔrsrcID; ° d ONLN dJAhM
)¢/* Atom Extender Rsrc ID */ ° d ONLN djL ΔX, (U ΔevenPaddedString; ° d ONLN dLhXÏ )¢/* Atom Description */ ° d ONLN dòW ¢c Æ (` ¢}; ° d ONLN dõb ~n ä (k ~};
° d ONLN dû~ ~â ’ *Flag Descriptions
° d ONLN d∞å ~òt *)deleteWhenRemoving/dontDeleteWhenRemoving ° d ONLN d€ó£+ +ê ?Determines if the file is deleted during a removal. When using ° d ONLN d£Ø * the ° d ONLN d £ Øå )deleteWhenRemoving ° d ONLN d1£åØ )l$ flag, if the target file exists and ° d ONLN dVت (∏@the user clicks Remove, the target file is deleted. If the file ° d ONLN dóª«# * Bdoes not exist on the target disk, this flag is ignored. The file ° d ONLN d⁄«”ÿ * -atom must be part of a package that uses the ° d ONLN d«ÿ” ) removable ° d ONLN d«”& )6 flag. ° d ONLN d”fl˚ (‹4Note that of the following File Atom flags, only the ° d ONLN dMflÎÄ * rsrcFork/noRsrcFork ° d ONLN d`flÄÎï )r and ° d ONLN deflïÎ )dataFork/noDataFork ° d ONLN dxflÎ )r flags ° d ONLN dΘ¿ (Ù'have any effect on the removal process. ° d ONLN dߡ ~ å ( ~-deleteWhenInstalling/dontDeleteWhenInstalling ° d ONLN d’
+ê ;Determines if a file is deleted during an installation when ° d ONLN d"9 *
using the ° d ONLN d9"i )+dontCopy ° d ONLN d#i"' )0- flag. Installer generally ignores this flag ° d ONLN dQ".T (+when using the ° d ONLN d`"T.l )Fcopy ° d ONLN dd"l.œ ) flag. When using the ° d ONLN d{.:Ü (7deleteWhenInstalling ° d ONLN dè.Ü: )x% flag, after the user clicks Install, ° d ONLN dµ:F (C>the target file is deleted if it exists, otherwise the flag is ° d ONLN dÙFRK * ignored. The ° d ONLN dFKR√ )=deleteWhenInstalling ° d ONLN dF√R( )x flag is primarily used ° d ONLN d.R^ ([:for deleting previously installed files that are no longer ° d ONLN di^j1 * needed. ° d ONLN dqr ~~ à ({ ~
copy/dontCopy ° d ONLN dr~ )ê>Determines if the file is copied during an installation. Note ° d ONLN dæ~äZ * that some flags ( ° d ONLN dœ~Zä¿ )LleaveAloneIfNewer ° d ONLN d‡~¿ä≈ )f, ° d ONLN d‚~≈ä
) keepExisting ° d ONLN dÓ~
ä )H, ° d ONLN däñV (ì copyIfUpdate ° d ONLN d¸äVñ, )H.) can prevent copying from happening under the ° d ONLN d+ñ¢z (ücircumstances specified. ° d ONLN dF™ ~∂\ (≥ ~%dontIgnoreLockedFile/ignoreLockedFile ° d ONLN dlµ¡˝ +ê 6Determines if an existing locked target file should be ° d ONLN d£¡Õ * 6automatically unlocked before replacing. Only use the ° d ONLN d⁄ÕŸn * ignoreLockedFile ° d ONLN dÍÕnŸ! )`* flag if you originally installed the file ˇV d ˇ ˇˇˇˇ d
° d ONLN d Q ]fl ( Z0locked or your software locks the file. Use the ,
Courier ° d ONLN d 1 ] iÜ * dontIgnoreLockedFile ° d ONLN d E ]Ü i )x flag the majority of times to ° d ONLN d d i uË ( r1preserve the user’s control over their Macintosh. ° d ONLN d ñ } ~ â8 ( Ü ~ dontSetFileLocked/setFileLocked ° d ONLN d ∂ à î +ê =Determines if the target file should be locked after copying. ° d ONLN d ı î †! * Use ° d ONLN d ˘ î! †o )
flag, the ° d ONLN daht (q>user will not be notified and the newer will be preserved. If ° d ONLN d†tÄ9 *
using the ° d ONLN d™t9Äü )+updateEvenIfNewer ° d ONLN dªtüÄ )f flag, an alert is shown that ° d ONLN dŸÄå* (â@has two options: Continue or Cancel. Clicking Cancel will stop ° d ONLN d åò& * >the installation, and clicking Continue will replace the newer ° d ONLN d Yò§µ * 'target file with the older source file. ° d ONLN d Ǩ∏P *Custom Install ° d ONLN d ê¨P∏T )B
° d ONLN d íÆT∑a )—
° d ONLN d ï¨a∏ñ )
If using the ° d ONLN d ¢¨ñ∏¸ )5leaveAloneIfNewer ° d ONLN d ≥¨¸∏& )f
flag, the ° d ONLN d æ∏ƒ (¡8user will be presented with an alert that provides three ° d ONLN d ˜ƒ–€ * /choices: Newer, Older or Cancel. If using the ˇ¬ d ˇ ˇˇˇˇ d
° d ONLN d Q ]t ( ZupdateEvenIfNewer ° d ONLN d Qt ], )f+ flag, the alert is the same as for an Easy ° d ONLN d = ] i0 ( fInstall. ° d ONLN d G q ~ } ( z ~keepExisting/updateExisting ° d ONLN d c | à( +ê ?Allows the scriptwriter to preserve an existing file when using ° d ONLN d £ à î * the ° d ONLN d ß à î8 )copy ° d ONLN d ´ à8 î[ ) and/or ° d ONLN d ≥ à[ îµ )#deleteOnInstall ° d ONLN d ¬ ൠî" )Z flag. This might be the ° d ONLN d ‹ î †( ( ùAcase if you want to preserve a preference file that contains user ° d ONLN d † ¨c * specific data. Use ° d ONLN d2 †c ¨´ )U keepExisting ° d ONLN d> †´ ¨. )H to prevent the Installer from ° d ONLN d] ¨ ∏$ ( µAdisturbing an existing target file. No copying will occur if the ° d ONLN dü ∏ ƒb * updateExisting ° d ONLN d≠ ∏b ƒƒ )T flag is used with the ° d ONLN dƒ ∏ƒ ƒ )b copyIfUpdate ° d ONLN d– ∏ ƒ$ )H flag. ° d ONLN d◊ à ~ ÿ2 ( ’ ~ copyIfUpdate/copyIfNewOrUpdate ° d ONLN dˆ ◊ „ +ê ;Allows the scriptwriter to update a file only if it already ° d ONLN d2 „ ÔÜ * exists when used with the ° d ONLN dL „Ü Ôû )xcopy ° d ONLN dP „û ÔÕ ) flag. Use ° d ONLN d\ „Õ Ô )/ copyIfUpdate ° d ONLN dh „ Ô )H to ° d ONLN dl Ô ˚÷ ( ¯.prevent a new file from being created. If the ° d ONLN dö Ô÷ ˚ )» copyIfUpdate ° d ONLN dß ˚n (flag is used with the ° d ONLN dΩ ˚n∂ )` keepExisting ° d ONLN d… ˚∂) )H flag then no copying will ° d ONLN d‰' (occur. ° d ONLN dÎ ~' ($ ~rsrcFork/noRsrcFork ° d ONLN dˇ'' )êADetermines if the resource fork of the file is affected during an ° d ONLN dA'3í * installation or removal. Use ° d ONLN d_'í3⁄ )Ñ resourceFork ° d ONLN dk'⁄3& )H to copy or delete ° d ONLN d~3? (<?the entire resource fork of the file during an installation, or ° d ONLN dæ?K¸ * 6delete the entire resource fork during a removal. Use ° d ONLN dıKWb * noResourceFork ° d ONLN dKbW )T, to not touch the resource fork of the file. ° d ONLN d0_ ~k (h ~dataFork/noDataFork ° d ONLN dD_k )ê=Determines if the data fork of the file is affected during an ° d ONLN dÇkwí * installation or removal. Use ° d ONLN d†kíw¬ )ÑdataFork ° d ONLN d®k¬w )0 to copy or delete the ° d ONLN døwÉ* (ÄBentire data fork of the file during an installation, or delete the ° d ONLN dÉèø * (entire data fork during a removal. Use ° d ONLN d*Éøè˚ )±
noDataFork ° d ONLN d4É˚è )< to not ° d ONLN d<èõô (ò touch the data fork of the file.
° d ONLN d Q ], ( ZCfinal target file, and therefore must be exact. If not copying the ° d ONLN d D ] i» * ,data fork, this field is ignored. (4-bytes) ,
Courier ° d ONLN d q q ~ } ( z ~Target Rsrc Fork Piece Size ° d ONLN d ç | à! +ê >The number of bytes the resource fork piece will occupy in the ° d ONLN d à à î * =target file. If not copying the resource fork, this field is ° d ONLN d
î † * <ignored. If the resource fork is decompressed using an Atom ° d ONLN dG † ¨* * ?Extender during the installation, then this value should be the ° d ONLN dá ¨ ∏ * >original noncompressed size of the source piece. The value is ° d ONLN dΔ ∏ ƒ- * @used to compute where multiple pieces are to be written into the ° d ONLN d ƒ – * :final target file, and therefore must be exact. (4-bytes) ° d ONLN dB ÿ ~ ‰ ¸ ( · ~Source Version Number ° d ONLN dX ÿ ‰' )ê=The version number (BCD format) of the source file when using ° d ONLN dñ ‰ * the ° d ONLN dö ‰ ò )useVersProcToCompare ° d ONLN dÆ ‰ò Δ )x flag. See ° d ONLN d∫ ‰Δ ).Inside Macintosh: ° d ONLN dÕ ¸ì ( ˘ Macintosh Toolbox Essentials ° d ONLN dÈ ì ¸, )Ö$, page 7-31 for a description of the ° d ONLN d ¸¢ (!version number format. (4-bytes) ° d ONLN d0 ~ ( ~Version Compare Rsrc ID ° d ONLN dH )ê>The resource ID of a Version Compare (‘invc’) script resource. ° d ONLN dà (# * >The resulting version number from the version function will be ° d ONLN d«(4g * compared with the ° d ONLN dŸ(g4ª )YVersion Number ° d ONLN dÁ(ª4+ )T field to determine if the ° d ONLN d4@# (=Btarget is newer or older than the source. If the resource ID is 0 ° d ONLN dE@LP * (zero) and the ° d ONLN dT@PL» )BuseVersProcToCompare ° d ONLN dh@»L )x flag is used the ° d ONLN dzLX¿ (U(Installer will default to comparing the ° d ONLN d¢L¿X )≤Source Version ° d ONLN d±Xd2 (aNumber ° d ONLN d∑X2d )$1 field with the version number in the ‘vers’ ID=1 ° d ONLN dÈdp# (mBresource contained in the target file. If no ‘vers’ ID=1 resource ° d ONLN d,p|$ * @exists then the target version number is assumed to be 0 (zero). ° d ONLN dn|à7 * (2-bytes) ° d ONLN dxê ~ú ¸ (ô ~Atom Extender Rsrc ID ° d ONLN déêú& )êAThe resource ID of an Atom Extender (‘inex’ script resource). (2 ° d ONLN dœê&ú* (ô&- ° d ONLN d–ú®* (•bytes) ° d ONLN d◊∞ ~º ¸ (π ~File Atom Description ° d ONLN dÌ∞º )ê8The File Atom Description field is an even-padded Pascal ° d ONLN d&º» * ?string describing the atom. This is used as part of the status ° d ONLN df»‘ * >dialog. If you do not supply a description the Installer will ° d ONLN d•‘‡ * ;display “Copying File: [file name]” or “Writing File: [file ° d ONLN d·‡Ï% * ?name].” If you supply a description it will be appended to the ° d ONLN d!ϯù * string “Copying “ or “Writing “.
° d ONLN dB 6$G ( 6 About the Resource Atom (‘inra’) " ° ∂ $ 4$0 ° ∂ ° ∂
° d ONLN dc) ~5$ +HaThe Resource Atom should be used to copy or delete a single resources in a file. Two versions of ° d ONLN d≈5 ~A- * athe Resource Atom script resource are understood by Installer 4.0, but it is recommended that you ° d ONLN d'A ~M ⁄ * use format version 1. ° d ONLN d=U ~a *VThe Resource Atom provides the following major features for copying or deleting files: ,
Zapf Dingbats
° d ONLN dîk ~t Ö *n
° d ONLN dñi êu~ )7Ability to update a resource only if it already exists.
° d ONLN dŒ ~à Ö (Ü ~n
° d ONLN d–} êâC ))Ability to preserve an existing resource.
° d ONLN d l± êΩq )2Decompression of the resource during installation.
° d ONLN d ü« ~– Ö (Œ ~n
° d ONLN d °≈ ê— )ZInstallation of a resource that has been split among multiple resources on multiple source ° d ONLN d ¸— ê› ´ * disks. ˇŒ d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ]$ ( Z ~`If you must copy all the resources from a single source file and merge them with the target file ° d ONLN d a ] ~ if * 1you may want to consider using the ResMerge Atom.
° d ONLN d ì Å 6 ï
( ê 6Using the Resource Atom " ° ∂ ï 4 ï0 ° ∂ ° ∂
° d ONLN d ´ ¶ ~ µ+ +H!Comparing Files By Version " ° ∂ ¥ | ¥0 ° ∂ ° ∂
° d ONLN d Δ π ~ ≈ *[Two new fields in the Resource Atom allow the scriptwriter to compare the source and target ° d ONLN d" ≈ ~ —) * bresource based on the version number. The first field holds the source file’s version number, and ° d ONLN dÖ — ~ › * Ythe second field holds the ID of a Version Compare (‘invc’) script resource. The Version ° d ONLN dfl › ~ È * [Compare script resource allows the scriptwriter to call a code resource that calculates the ° d ONLN d; È ~ ı% * &version number of the target resource. ° d ONLN db ˝ ~ ) *`To compare the version number of the target resource to the source version number entered in the ° d ONLN d√ ~ * WResource Atom you’ll need to create and attach a Version Compare script resource to the ° d ONLN d ~!
* XResource Atom. Since setting and obtaining version number information for an individual ° d ONLN dt! ~-( * `resource is not a feature of the Resource Manager, extracting the version number from the target ° d ONLN d’- ~9 * ]resource depends on how the resource encodes its version number. Most examples of this use a ° d ONLN d39 ~E¬ * Iheader at the beginning of the resource to hold this type of information.
° d ONLN d}Y ~h~ *"'Using Split Sources with Resource Atoms " ° ∂ g |g0 ° ∂ ° ∂
° d ONLN d•l ~x) *dThe format 1 version of the Resource Atom script resource contains a list of source entries. If the ° d ONLN d
x ~Ñ! * boriginal resource must be split into smaller resource pieces, an entry for each split source piece ° d ONLN dmÑ ~ê * _must be placed into the source list. Each entry contains information about the location of the ° d ONLN dÕê ~ú * asource file (‘infs’ ID), the source resource type, the source resource ID, the target size of the ° d ONLN d/ú ~® * `resource piece, and the source resource name. The target size field must contain the exact size ° d ONLN dê® ~¥$ * `the source piece will appear in the target resource. If the piece is being decompressed with an ° d ONLN dÒ¥ ~¿- * `Atom Extender during installation, this field must contain the original uncompressed size of the ° d ONLN dR¿ ~à ô * piece. ° d ONLN dZ‘ ~‡# *`When specifying more than one split resource piece, the Installer joins the pieces into a target ° d ONLN dª‡ ~Ï& * cresource in the order the sources are specified. Generally, you’ll want to use ‘part’ for the type ° d ONLN d Ï ~¯' * _of source resources that have been split and/or compressed. This prevents resources compressed ° d ONLN d¯ ~ * Yusing third-party schemes from being confused with the original resource, especially when ° d ONLN dŸ ~ * $using tools like ResEdit and DeRez.
° d ONLN d˛$ ~3ê *"(Using Atom Extenders with Resource Atoms " ° ∂ 2 |20 ° ∂ ° ∂
° d ONLN d '7 ~C& *]You’ll use an Atom Extender to decompress a resource that was compressed by you to save space ° d ONLN d ÖC ~O * Yon your source disks. The Resource Atom is expanded into one or more parts that the Atom ° d ONLN d flO ~[ ˙ * Extender receives with the ,
Courier ° d ONLN d ˙O ˙[< )| kBeforePart ° d ONLN d
O<[Q )B and ° d ONLN d
OQ[ç )
kAfterPart ° d ONLN d
Oç[# )<" messages. There will be one part ° d ONLN d
7[ ~g (d ~^for each source resource piece specified in the source list. Since owned resources are always ° d ONLN d
ñg ~s. * ]copied whole and are usually relatively small, the owner’s Atom Extender is never called when ° d ONLN d
Ùs ~ ˚ * copying its owned resources.
° d ONLN d â ~î ö *NOTE
° d ONLN d ó ~£ í *The ° d ONLN d ó í£ Œ )
compressed ° d ONLN d $ó Œ£& )<O flag in the resource attributes should NOT be set on any source resource being ° d ONLN d t£ ~Ø (¨ ~Vdecompressed using an Atom Extender. This flag is presently reserved for use by Apple ° d ONLN d ÀØ ~ª ¡ * Computer, Inc. ,
° d ONLN d ¶ ~ ≤ ® +H#define ° d ONLN d á ¶ ¥ ≤ )6resourceAtomFlags ° d ONLN d ¶ ¶
≤ ( Ø
\ ° d ONLN d ™ ± ¢ Ω Ã ( ∫ ¢boolean ° d ONLN d ≥ ± Í ΩÏ )H+dontDeleteWhenRemoving, deleteWhenRemoving; ° d ONLN d ‡ ±
Ω ( ∫
\ ° d ONLN d ‰ º ¢ » Ã ( ≈ ¢boolean ° d ONLN d Ì º Í » )H/dontDeleteWhenInstalling, deleteWhenInstalling; ° d ONLN d º
» ( ≈
\ ° d ONLN d! « ¢ ” Ã ( – ¢boolean ° d ONLN d* « Í ”D )HdontCopy, copy; ° d ONLN dD «
” ( –
\ ° d ONLN dH “ ¢ fi Í ( € ¢ fill bit[6]; ° d ONLN d\ “z fiº )ÿ /* Reserved ° d ONLN dh “¬ fiŒ )H*/ ° d ONLN dn “
fi )H\ ° d ONLN dr › ¢ È Ã ( Ê ¢boolean ° d ONLN d{ › Í Èå )HnoTgtRequired, tgtRequired; ° d ONLN dù ›
È ( Ê
\ ° d ONLN d° Ë ¢ Ù Ã ( Ò ¢boolean ° d ONLN d™ Ë Í Ùò )H updateExisting, keepExisting; ° d ONLN dŒ Ë
Ù ( Ò
\ ° d ONLN d“ Û ¢ ˇ à ( ¸ ¢boolean ° d ONLN d€ Û Í ˇ™ )H copyIfNewOrUpdate, copyIfUpdate; ° d ONLN d Û
ˇ ( ¸
\ ° d ONLN d ˛ ¢
à ( ¢boolean ° d ONLN d ˛ Í
‘ )H'dontIgnoreProtection, ignoreProtection; ° d ONLN d8 ˛
(
\ ° d ONLN d< ¢ Ã ( ¢boolean ° d ONLN dE Íû )H srcNeedExist, srcNeedNotExist; ° d ONLN di
(
\ ° d ONLN dm ¢ Ã ( ¢boolean ° d ONLN dv Í 8 )H
byName, byID; ° d ONLN dè
(
\ ° d ONLN dì ¢+ Ã (( ¢boolean ° d ONLN dú Í+§ )H nameNeedNotMatch, nameMustMatch ° d ONLN dæ5 ~A Ã (> ~
type 'inra' { ° d ONLN dŒ@ ¢L “ +$ switch { ° d ONLN d⁄K ¥W +
case format1: ° d ONLN dÏV Δb& + key integer = 1; ° d ONLN d Vhb" )¢ /* Resource Atom Format vers */ ° d ONLN d$a Δm2 (j ΔresourceAtomFlags; ° d ONLN d9ahm˛ )¢/* Resource Atom Flags */ ° d ONLN dWl Δx, (u Δunsigned longInt; ° d ONLN dllhx‡ )¢/* Total Target Size ° d ONLN dÅlÊxÚ )~*/ ° d ONLN dàÇ Δé (ã Δ fileSpecID; ° d ONLN dôÇhéÏ )¢/* Target File Spec */ ° d ONLN d¥ç Δô ¸ (ñ Δ rsrcType; ° d ONLN d√çhô )¢/* Target Resource Type */ ° d ONLN d‚ò Δ§ (° ΔrsrcID; ° d ONLN dòh§¯ )¢/* Target Resource ID */ ° d ONLN d
£ ΔØ ˆ (¨ Δinteger; ° d ONLN d £hØ( )¢ /* Target Resource Attributes */ ° d ONLN dAÆ Δ∫, (∑ ΔevenPaddedString; ° d ONLN dVÆh∫ )¢/* Target Resource Name */ ° d ONLN duƒ Δ–n (Õ Δ integer = $$CountOf (Parts); ° d ONLN díƒz–˛ )¥/* Number of Pieces */ ° d ONLN d≠œ Δ€2 (ÿ Δwide array Parts { ° d ONLN d≈⁄ ÿÊ + fileSpecID; ° d ONLN d÷⁄zÊ" )¢ /* Source Piece File Spec */ ° d ONLN d¯Â ÿÒ (Ó ÿ rsrcType; ° d ONLN dÂzÒÚ )¢/* Source Piece Type ° d ONLN d Â¯Ò )~*/ ° d ONLN d$ ÿ¸ (˘ ÿrsrcID; ° d ONLN d2z¸ )¢/* Source Piece Rsrc ID */ ° d ONLN dR˚ ÿ> ( ÿunsigned longInt; ° d ONLN dg˚zÚ )¢/* Target Piece Size ° d ONLN d|˚¯ )~*/ ° d ONLN dÑ ÿ8 ( ÿevenPaddedString ° d ONLN dòz" )¢ /* Source Piece Rsrc Name */ ° d ONLN dπ Δ Ã ( Δ} ° d ONLN dø' Δ3, *unsigned longint; ° d ONLN d‘'h3
)¢/* Source Version Number */ ° d ONLN dÙ2 Δ> (; ΔrsrcID; ° d ONLN d2h> )¢ /* Version Compare Rsrc ID */ ° d ONLN d$= ΔI (F ΔrsrcID; ° d ONLN d2=hI
)¢/* Atom Extender Rsrc ID */ ° d ONLN dRH ΔT, (Q ΔevenPaddedString; ° d ONLN dgHhTÏ )¢/* Atom Description */ ° d ONLN dÄS ¢_ Æ (\ ¢}; ° d ONLN dÉ^ ~j ä (g ~};
° d ONLN dÜz ~Ö ’ *Flag Descriptions
° d ONLN dòà ~ît *)deleteWhenRemoving/dontDeleteWhenRemoving ° d ONLN d√ìü% +ê =Determines if the resource is deleted during a removal. When ° d ONLN dü´9 *
using the ° d ONLN d ü9´• )+deleteWhenRemoving ° d ONLN d ü•´ )l flag, if the target resource ° d ONLN d;´∑. (¥Bexists and the user clicks Remove, the target resource is deleted. ° d ONLN d∑√ * ?If the resource does not exist on the target disk, this flag is ° d ONLN dø√œ * 7ignored. Note that the Resource Atom must be part of a ° d ONLN d˜œ€s * package that uses the ° d ONLN d
° d ONLN d Q ~ ]å ( Z ~-deleteWhenInstalling/dontDeleteWhenInstalling ° d ONLN d . \ h +ê <Determines if the resource is deleted during an installation ° d ONLN d k h tT * when using the ° d ONLN d z hT tÑ )FdontCopy ° d ONLN d Ç hÑ tÁ )0 flag. When using the ° d ONLN d ô t ÄÜ ( }deleteWhenInstalling ° d ONLN d ≠ tÜ Ä )x% flag, after the user clicks Install, ° d ONLN d ” Ä å% ( âBthe target resource is deleted if it exists, otherwise the flag is ° d ONLN d å òK * ignored. The ° d ONLN d$ åK ò√ )=deleteWhenInstalling ° d ONLN d8 å√ ò( )x flag is primarily used ° d ONLN dP ò § ( °>for deleting previously installed resources that are no longer ° d ONLN dè § ∞ö * needed. Note that some flags ( ° d ONLN dÆ §ö ∞ )åleaveAloneIfNewer ° d ONLN dø § ∞ )f, ° d ONLN d¡ ∞ ºV ( π keepExisting ° d ONLN dÕ ∞V º )H+) can prevent deletion from happening under ° d ONLN d˘ º »å ( ≈ the circumstances specified. ° d ONLN d – ~ ‹ à ( Ÿ ~
copy/dontCopy ° d ONLN d& – ‹ı )ê5Determines if the resource is copied or not during an ° d ONLN d\ ‹ ˱ * %installation. Note that some flags ( ° d ONLN dÅ ‹± Ë )£leaveAloneIfNewer ° d ONLN dí ‹ Ë )f, ° d ONLN dî Ë ÙV ( Ò keepExisting ° d ONLN d† ËV Ù[ )H, ° d ONLN d¢ Ë[ Ù£ ) copyIfUpdate ° d ONLN dÆ Ë£ Ù )H) can prevent copying from ° d ONLN d… Ù ⁄ ( ˝,happening under the circumstances specified. ° d ONLN d¯ ~P ( ~#leaveAloneIfNewer/updateEvenIfNewer ° d ONLN d ) +ê >Determines what action the Installer should take if the target ° d ONLN d[ +! * @resource is newer than the source resource that is replacing it. ° d ONLN dù+7, * ?The scriptwriter must write a code resource that determines the ° d ONLN d›7C * :version number by referencing the resource ID of a Version ° d ONLN dCO» * +Compare (‘invc’) script resource. Use the ° d ONLN dCC»O. )∫leaveAloneIfNewer ° d ONLN dUO[ (X<flag to prevent the older source resource from replacing the ° d ONLN dí[g * >newer target resource during an installation. Unlike the File ° d ONLN d—gs * >Atom, the user is not given a chance to override the result of ° d ONLN dsb * this flag. Use the ° d ONLN d$sb» )TupdateEvenIfNewer ° d ONLN d5s»' )f flag if the version of ° d ONLN dMã (à<this resource must be synchronized with specific versions of ° d ONLN däãó
* ;other files or resources that are part of the installation. ° d ONLN dΔü ~´ (® ~tgtRequired/noTgtRequired ° d ONLN d‡™∂ +ê =The target file for this resource must already exist. If the ° d ONLN d ∂¬, * Dtarget file does not exist, the user is warned that a target file is ° d ONLN dc¬Œ$ * =needed. (For example, AppleShare installs resources into the ° d ONLN d°Œ⁄ * ASystem file, but if there is no system file, the Installer alerts ° d ONLN d„⁄Ê- * ?the user, rather than creating a System file which has only the ° d ONLN d#ÊÚ⁄ * -AppleShare resources in it.) When using the ° d ONLN dPÊ⁄Ú( )Ã
noTgtRequired ° d ONLN d^Ú˛( (˚Bflag and the target file does not exist, the Installer will create ° d ONLN d°˛
* one. ° d ONLN d¶ ~ ( ~keepExisting/updateExisting ° d ONLN d¬ )" +ê =Allows the scriptwriter to preserve an existing resource when ° d ONLN d )59 *
using the ° d ONLN d
)95Q )+copy ° d ONLN d)Q5t ) and/or ° d ONLN d)t5Œ )#deleteOnInstall ° d ONLN d%)Œ5) )Z flag. This might be ° d ONLN d;5A (>;the case if you want to preserve a preference resource that ° d ONLN dwAMû * "contains user specific data. Use ° d ONLN dôAûMÊ )ê keepExisting ° d ONLN d•AÊM( )H to prevent the ° d ONLN dµMY. (VBInstaller from disturbing an existing target resource. No copying ° d ONLN d¯YeX * will occur if the ° d ONLN d
YXe¨ )JupdateExisting ° d ONLN d Y¨e )T flag is used with the ° d ONLN d /eqV (n copyIfUpdate ° d ONLN d ;eVqn )H flag. ° d ONLN d By ~Ö2 (Ç ~ copyIfUpdate/copyIfNewOrUpdate ° d ONLN d aÑê& +ê ?Allows the scriptwriter to update a resource only if it already ° d ONLN d °êúT * exists. Use the ° d ONLN d ≤êTúú )F copyIfUpdate ° d ONLN d æêúú# )H flag to prevent a new resource ° d ONLN d fiú®Ñ (• from being created. If the ° d ONLN d ˙úѮà )v copyIfUpdate ° d ONLN d
úî, )H flag is used with the ° d ONLN d
®¥V (± keepExisting ° d ONLN d
)®V¥‰ )H! flag then no copying will occur. ° d ONLN d
Kº ~»\ (≈ ~%ignoreProtection/dontIgnoreProtection ° d ONLN d
q«”- +ê ADetermines if the user should be alerted if any resource with its ° d ONLN d
≥”fl! * >protected bit set will be replaced or deleted. When using the ˇ‘ d ˇ ˇˇˇˇ d
° d ONLN d Q ]n ( ZignoreProtection ° d ONLN d Qn ] )`% flag the resource is deleted from or ° d ONLN d 6 ] i ( f@updated in the target file even if it is protected in the target ° d ONLN d w i u" * file. ° d ONLN d } } ~ â& ( Ü ~ srcNeedExist/srcNeedNotExist ° d ONLN d ö à î +ê 9Determines whether the source resources must exist on the ° d ONLN d ‘ î †k * source disk. Use the ° d ONLN d Í îk †≈ )]srcNeedNotExist ° d ONLN d ˘ î≈ † )Z flag if the source ° d ONLN d
nameMustMatch ° d ONLN dƒ ¸\≠ )N flag. If using the ° d ONLN dŸ ¸≠— )QbyName ° d ONLN dfl ¸—( )$ flag the resource is ° d ONLN dı, (Afound in the source and target file using only the name specified ° d ONLN d7 + * in the ° d ONLN d>+ [ ) Resource ° d ONLN dF[ ] )0 ° d ONLN dG] u )Name ° d ONLN dKu ∫ ) field. Use the ° d ONLN d\∫ fi )EbyName ° d ONLN dbfi )$
° d ONLN dMü ~´ ‰ *Total Target Size ° d ONLN d_ü´* )êAThe size in bytes of the copied target resource and all its owned ° d ONLN d°´∑- * Dresources. This field is used only by the Installer in figuring the ° d ONLN dÊ∑√› * 0disk size needed for an installation. (4-bytes) ° d ONLN dÀ ~◊ (‘ ~Target Resource File Spec. ° d ONLN d3÷‚ +ê AThe resource ID of a Target File Spec script resource (‘intf’, or ° d ONLN du‚Ó! * B‘infs’ for pre-4,0 scripts) describing the file on the target disk ° d ONLN d∏Ó˙ * <where the resource will be deleted, created, or updated. (2 ° d ONLN dÙÓ˙ (˜- ° d ONLN dı˙* (bytes) ° d ONLN d˝ ~ ˆ ( ~Target Resource Type ° d ONLN d )ê>The resource type the Installer will use to find or create the ° d ONLN dQ&∞ * 'resource in the target file. (4-bytes) ° d ONLN dz. ~: Í (7 ~Target Resource ID ° d ONLN dç.: )ê<The resource ID the Installer will use to find or create the ° d ONLN d :F * ?resource in the target file. If the ID of the resource doesn’t ° d ONLN d
° d ONLN d Q ~ ] ( Z ~Source Piece File Spec. ° d ONLN d Q ] )ê>The resource ID of a Source File Spec. (‘infs’) describing the ° d ONLN d W ] i+ * Dsource file that holds the resource part. If you’re just deleting a ° d ONLN d ú i u( * Aresource and therefore don’t need a source file, leave the source ° d ONLN d fi u Åm * list empty. (2-bytes) ° d ONLN d ı â ~ ï ‰ ( í ~Source Piece Type ° d ONLN d â ï( )êBThe resource type of the resource piece being copied. If there is ° d ONLN dJ ï °% * >more then one piece, it’s recommended that the type by ‘part’. ° d ONLN dä ° ≠7 * (4-bytes) ° d ONLN dï µ ~ ¡ ÿ ( æ ~Source Piece ID ° d ONLN d• µ ¡* )êBThe resource ID of the resource piece being copied. This field is ° d ONLN dË ¡ Õ¯ * 6ignored if the resource piece is being found by name ( ° d ONLN d ¡¯ Õ )ÍbyName ° d ONLN d% Õ Ÿu ( ÷flag is used). (2-bytes) ° d ONLN d@ · ~ Ì ‰ ( Í ~Target Piece Size ° d ONLN dR · Ì* )ê@The number of bytes the resource piece will occupy in the target ° d ONLN dì Ì ˘ * 9file. If the resource will be decompressed using an Atom ° d ONLN dÕ ˘# * =Extender, then this value should be the noncompressed size of ° d ONLN d ( * ?the source piece. This value is used to compute where multiple ° d ONLN dK * @pieces are to be written in the final target file, and therefore ° d ONLN då )y * must be exact. (4-bytes) ° d ONLN dß1 ~= (: ~Source Piece Resource Name ° d ONLN d¬<H, +ê @The name of the source resource. This field is only needed when ° d ONLN dHT * 2finding the source resource by its resource name ( ° d ONLN d5HÂT )◊byName ° d ONLN d;H T( )$ flag is ° d ONLN dDT`≠ (]#used). (even-padded Pascal string) ° d ONLN dhh ~t ¸ (q ~Source Version Number ° d ONLN d~ht) )ê=The version number (BCD format) of the source resource when a ° d ONLN dºtÄ, * @Version Compare function is used to calculate the target version ° d ONLN d˝Äå^ * number. (4-bytes) ° d ONLN dî ~† (ù ~Version Compare Rsrc ID ° d ONLN d(î† )ê>The resource ID of a Version Compare (‘invc’) script resource. ° d ONLN dh†¨# * >The resulting version number from the version function will be ° d ONLN dߨ∏g * compared with the ° d ONLN dπ¨g∏ )YSource Version Number ° d ONLN dŒ¨Â∏ )~ field to ° d ONLN dÿ∏ƒ- (¡Cdetermine if the target is newer or older than the source. If this ° d ONLN d ƒ–( * Afield is 0 (zero) then the target version number is assumed to be ° d ONLN d^–‹` * 0 (zero). (2-bytes) ° d ONLN ds‰ ~ ¸ (Ì ~Atom Extender Rsrc ID ° d ONLN d≠)ê=The resource ID of an Atom Extender (‘inex’) script resource. ° d ONLN d»¸ * 8This Atom Extender will be called during copying of each ° d ONLN d¸x * resource part. (2-bytes) ° d ONLN d *8When using InstaCompOne compression enter a value of 241 ° d ONLN dU (& * here. ° d ONLN d[0 ~< (9 ~Resource Atom Description ° d ONLN dwCO" +êThe ° d ONLN d{C"OX ) Resource ° d ONLN dÑCXO )6(Atom Description field is an even-padded ° d ONLN d≠O[ (X?Pascal string describing the atom. This is used as part of the ° d ONLN dÌ[g! * @status dialog. If you do not supply a description the Installer ° d ONLN d.gs, * Awill display “Building File: [file name]” or “Writing File: [file ° d ONLN dps% * ?name].” If you supply a description it will be appended to the ° d ONLN d∞ãü * !string “Building “ or “Writing “. ˇû d ˇ ˇˇˇˇ d
° d ONLN d Q 6 ej ( ` 6%About the Resource List Atom (‘inr#’) " ° ∂ e 4 e0 ° ∂ ° ∂
° d ONLN d & j ~ v +H[The Resource List Atom is a unique atom that provides a more compact storage structure with ° d ONLN d Ç v ~ Ç * \slightly reduced functionality for installing resources. This enables scriptwriters to copy ° d ONLN d fl Ç ~ é * Tthousands of individual resources without the overhead of thousands of Resource Atom ° d ONLN d4 é ~ ö * bresources in their script file. For installation of less than a 100 resources, most scriptwriters ° d ONLN dó ö ~ ¶\ * 0should continue using individual Resource Atoms.
° d ONLN d» æ 6 “, ( Õ 6 Using the Resource List Atom " ° ∂ “ 4 “0 ° ∂ ° ∂
° d ONLN d ◊ ~ „$ +H]The Resource List Atom is actually an array of individual Resource Atom records. The records ° d ONLN dC „ ~ Ô, * aare of a fixed size, so some options available in format 1 of the Resource Atom are not available ° d ONLN d• Ô ~ ˚ Ù * in the Resource List Atom. ° d ONLN d¡ ~' *]Use format1 Resource Atoms instead of the Resource List Atom if you need any of the following ° d ONLN d ~ ¶ * features: ,
Zapf Dingbats
° d ONLN d*% ~. Ö *n
° d ONLN d,# ê/C ))Find a source resource based on its name.
° d ONLN dV9 ~B Ö (@ ~n
° d ONLN dX7 êCp )4Copy a resource that is split across multiple files.
° d ONLN dçM ~V Ö (T ~n
° d ONLN dèK êW ) Specify a target resource name.
° d ONLN d∞a ~j Ö (h ~n
° d ONLN d≤_ êkä )2Use with InstaCompOne decompression Atom Extender.
° d ONLN dÊu ~~ Ö (| ~n
° d ONLN dËs ê )VChange the type or ID during installation. The Resource List Atom requires the target ° d ONLN d? êã * Gresource type and ID to be the same as the source resource type and ID.
° d ONLN dáü ~Æ∞ (™ ~-Referencing Resource Atom Lists from Packages " ° ∂ ≠ |≠0 ° ∂ ° ∂
° d ONLN dµ≤ ~æ$ *^Unlike other atoms, Resource Atom Lists are not referenced using their own atom type (‘inr#’). ° d ONLN dæ ~ # * ]Instead, packages should reference the atom type ‘inra’ and the ID entered in the Resource ID ° d ONLN ds ~÷# * _field of the resource atom record inside the Resource Atom List array. When an ‘inra’ is found ° d ONLN d”÷ ~‚ * `referenced from a package, the Installer first looks for a Resource List Atom (‘inr#’) resource, ° d ONLN d4‚ ~Ó * aand if not found looks for an actual resource of type ‘inra’ and the specified ID in script file. ° d ONLN dóÓ ~˙& * ^When the Resource List Atom resource is found, the Installer searches through the list looking ° d ONLN dˆ˙ ~§ * Cfor a resource record that matches the requested resource ID. The ,
Courier ° d ONLN d9˙§Ê (§ Resource ID ° d ONLN dD˙Ê )B
field in the ° d ONLN dR ~C ( ~,record holds a 2-byte value that you create.
° d ONLN d* 6>2 (9 6 Resource List Atom Reference " ° ∂ > 4>0 ° ∂ ° ∂
° d ONLN dúC ~Oÿ +HQThis section describes the resource description of the ‘inr#’ resource, format 0.
° d ONLN dÓc 6s Ω (o 6Resource Description " ° ∂ s 4s0 ° ∂ ° ∂
° d ONLN d ~ã Ã +H
type 'inr#' { ° d ONLN dä ¢ñ “ +$ switch { ° d ONLN d ï ¥° +
° d ONLN d ˇ ~ - *aThe flags for the Resource List Atom are identical to format 1 of the Resource Atom. Since there ° d ONLN dR ~“ * Lis no source name field in the Resource List Atom you should always use the ° d ONLN dû “Í (“byID ° d ONLN d¢ Í˝ ) and ° d ONLN dß ~# fi ( ~nameNeedNotMatch ° d ONLN d∑ fi# ˙ )` flags.
° d ONLN d¿- ~8 ÿ (5 ~Field Descriptions
° d ONLN d”; ~G ¿ * Resource ID ° d ONLN dfl;G )ê;The ID value that will be used to find this record from the ° d ONLN dGS, * @reference in a package. For example, if you choose the ID value ° d ONLN d\S_* * >of 369, then the reference from a package should have the type ° d ONLN dõ_kõ * !‘inra’ and the ID 369. (4-bytes) ° d ONLN dæs ~ ‰ (| ~Total Target Size ° d ONLN d–s )ê=The size, in bytes, of the copied target resource and all its ° d ONLN dã * >owned resources. This field is only used by the Installer for ° d ONLN dMãó$ * @calculating the disk size needed for an installation. (4-bytes) ° d ONLN dèü ~´ ‰ (® ~Target File Spec. ° d ONLN d°ü´ )êAThe resource ID of a Target File Spec script resource (‘intf’, or ° d ONLN d„´∑! * B‘infs’ for pre-4,0 scripts) describing the file on the target disk ° d ONLN d&∑√ * <where the resource will be deleted, created, or updated. (2 ° d ONLN db∑√ (¿- ° d ONLN dc√œ* (Ãbytes) ° d ONLN dk◊ ~„ ‰ (‡ ~Source File Spec. ° d ONLN d}◊„ )ê>The resource ID of a Source File Spec. (‘infs’) describing the ° d ONLN dº„Ô* * Dsource file that holds the source resource. If you’re just deleting ° d ONLN dÔ˚, * Ca resource and therefore don’t need a source file, place a 0 (zero) ° d ONLN dE˚u * in this field. (2-bytes) ° d ONLN d_ ~ ¸ ( ~Src/Tgt Resource Type ° d ONLN du" )ê@The resource type the Installer will use to find the resource in ° d ONLN d∂'* * Cthe target and source file. If the resource must be created in the ° d ONLN d˙'3‡ * 2target file it will be given this type. (4-bytes) ° d ONLN d.; ~G (D ~Src/Tgt Resource ID ° d ONLN dB;G+ )êBThe resource ID the Installer will use to find the resource in the ° d ONLN dÖGS * ?target and source file. If the resource must be created in the ° d ONLN d≈S_◊ * 0target file it will be given this ID. (2-bytes) ° d ONLN d˜g ~s (p ~Target Resource Attributes ° d ONLN dr~ +ê =The attributes that will be given to the target resource when ° d ONLN dP~äa * copying. (2-bytes) ° d ONLN deí ~û ¸ (õ ~Source Version Number ° d ONLN d{íû) )ê=The version number (BCD format) of the source resource when a ° d ONLN dπû™, * @Version Compare function is used to calculate the target version ° d ONLN d˙™∂^ * number. (4-bytes) ° d ONLN d
æ ~ (« ~Version Compare Rsrc ID ° d ONLN d %æ )ê>The resource ID of a Version Compare (‘invc’) script resource. ° d ONLN d e ÷. * >The resulting version number from the Version Compare function ° d ONLN d §÷‚â * will be compared with the ° d ONLN d æ÷â‚ ){Source Version Number ° d ONLN d ”÷‚+ )~ field to ˇ d ˇ ˇˇˇˇ d
° d ONLN d Q ]- ( ZCdetermine if the target is newer or older than the source. If this ° d ONLN d D ] i( * Afield is 0 (zero) then the target version number is assumed to be ° d ONLN d Ü i u` * 0 (zero). (2-bytes) ,
° d ONLN d ~ # +HaThe Font Atom is used to describe a set of font strikes (size/style) from a specified font family ° d ONLN dk ~* * [which should be copied to or removed from a file. Two versions of the Resource Atom script ° d ONLN d«* ~6 * ^resource are understood by Installer 4.0, but it is recommended that you use format version 1. ° d ONLN d&> ~JÔ *RThe Font Atom provides the following major features for copying or deleting fonts: ,
Zapf Dingbats
° d ONLN dyT ~] Ö *n
° d ONLN d{R ê^N ),Ability to preserve an existing font strike.
° d ONLN d®h ~q Ö (o ~n
° d ONLN d™f êr )UAbility to specify an individual strike to copy/delete or simple mode that copies the ° d ONLN d r ê~ fi * complete family.
° d ONLN dà ~ë Ö (è ~n
° d ONLN dÜ êí )TSupport for installing into all versions of System Software with a single Font Atom.
° d ONLN dhú ~• Ö (£ ~n
° d ONLN djö ê¶Ò )ODecompression of font resources (‘NFNT’, ‘sfnt’ or ‘FONT’) during installation.
° d ONLN d∫∞ ~π Ö (∑ ~n
° d ONLN dºÆ ê∫) )]Installation of a font strike that has been split among multiple resources on multiple source ° d ONLN d∫ êΔ ´ * disks.
° d ONLN d!fi 6Ú ‚ (Ì 6Using the Font Atom " ° ∂ Ú 4Ú0 ° ∂ ° ∂
° d ONLN d5 ~e +H!"Auto-Routing Under Pre-7.1 Systems " ° ∂ |0 ° ∂ ° ∂
° d ONLN dX ~"
*YTo overcome the effort involved with installing fonts into the various versions of System ° d ONLN d≤" ~. * [Software, the Installer will automatically place the font resources into the System file if ° d ONLN d. ~: * _installing into a System Folder that does not support the “Fonts” folder. To use this feature, ° d ONLN dn: ~F$ * `write your script to always install into a file in the System Folder’s “Fonts” folder. Make the ° d ONLN dœF ~R * ]target file path start with the reserved folder name “special-font” and reference this target ° d ONLN d-R ~^¥ * Ffile spec. from the Font Atom, and the Installer will handle the rest.
° d ONLN dth ~s ö *NOTE
° d ONLN dyv ~Ç+ *\System Software installation scriptwriters should understand how the Installer decides where ° d ONLN d÷Ç ~é- * ethe font resources will be installed to avert disasters, and bugs. The Installer uses the version of ° d ONLN d<é ~ö * ]the target System file and the existence of a Resource Atom installing the ‘fld#’ resource to ° d ONLN döö ~¶ * ]decide whether to auto-route or not. You must be installing a ‘fld#’ resource into a pre-7.1 ° d ONLN d¯¶ ~≤' * _System file at the same time as the fonts to let the Installer know you are upgrading to System ° d ONLN d X≤ ~æ ∏ * 7.1 or newer.
° d ONLN d Q ~ `p ( \ ~$Using Atom Extenders with Font Atoms " ° ∂ _ | _0 ° ∂ ° ∂
° d ONLN d % d ~ p *\You’ll use an Atom Extender to decompress font resources that were compressed by you to save ° d ONLN d Ç p ~ |# * ^space on your source disks. Minor constraints are required when using the Font Atom with this ° d ONLN d · | ~ à ¢ * feature. ° d ONLN d Í ê ~ ú *XScriptwriters must specify individual strikes(size and style) to copy when using an Atom ° d ONLN dC ú ~ ® * `Extender to decompress font resources. This is required because the target piece sizes for each ° d ONLN d§ ® ~ ¥ * ^strike must be entered in the optional source list. It’s recommended to place compressed font ° d ONLN d ¥ ~ ¿9 * ,resource data into resources of type ‘part’. ° d ONLN d2 » ~ ‘ *YThe Font Atom is expanded into one or more parts that the Atom Extender receives with the ,
Courier ° d ONLN då ‘ ~ ‡ ¿ * kBeforePart ° d ONLN dó ‘ ¿ ‡ ’ )B and ° d ONLN dú ‘ ’ ‡ )
kAfterPart ° d ONLN d¶ ‘ ‡
)<8 messages. As each part is installed, the Atom Extender ° d ONLN dfl ‡ ~ Ï$ ( È ~_attached to the original Font Atom will be called for each part. There will be a part for each ° d ONLN d? Ï ~ ¯ * bsource resource piece being copied. The only exception to this rule is for strikes that reference ° d ONLN d¢ ¯ ~# * `font resources in ROM. Since there is no data copied for these strikes the Atom Extender is not ° d ONLN d ~ û * called.
° d ONLN d ~% ö *NOTE
° d ONLN d( ~4 *XThe ‘FOND’ resource is always copied using the Installer’s default copy mechanism. This ° d ONLN di4 ~@- * ]prevents the scriptwriter from decompressing the ‘FOND’ resource using an Atom Extender. The ° d ONLN d«@ ~L * X‘FOND’ resource is the road map to other font resources (‘FONT, ‘NFNT’, and ‘sfnt’), and ° d ONLN d L ~X& * ]therefore must never be compressed. We suggest that you convert the ‘FOND’ resource into the ° d ONLN d~X ~d Ì * type ‘iFND’ and use the ° d ONLN dñX ÌdG )oencodedFONDRsrc ° d ONLN d•XGd) )Z4 flag when compressing any of the font resources it ° d ONLN d⁄d ~p (m ~Xreferences. This will prevent the system software from becoming confused when finding a ° d ONLN d3p ~|# * a‘FOND’ resource in your source file that may reference not existent font resources. In addition, ° d ONLN dï| ~à ê * the ° d ONLN dô| êà Ã )
compressed ° d ONLN d£| Ãà+ )<Q flag should NOT be set in the resource attributes of the ‘part’ resource because ° d ONLN dıà ~îñ (ë ~@this flag is presently reserved for use by Apple Computer, Inc. ,
Zapf Dingbats
° d ONLN d5äñìù (ëñu
° d ONLN d7¨ 6¿ Ë (ª 6Font Atom Reference " ° ∂ ¿ 4¿0 ° ∂ ° ∂
° d ONLN dK≈ ~—Ú +HXThis section describes the resource description of the ‘inff’ script resource, format 1.
\ ° d ONLN d€ ê ÿ ( ê fill bit[9]; ° d ONLN dÚ ûÚ (û/* Reserved */ ° d ONLN d
)l\ ° d ONLN d ê# ∫ ( êBoolean ° d ONLN d
Δ#Ä )6 noExtendedStyle, extendedStyle; ° d ONLN d-å#
)Δ/* Extended style */\ ° d ONLN dD" ê. ∫ (+ êBoolean ° d ONLN dL" Δ. )67noCondensedStyle, condensedStyle;/* Condensed style */\ ° d ONLN dÖ- ê9 ∫ (6 êBoolean ° d ONLN dç- Δ9 )6noShadowStyle, ° d ONLN dù-29z )l shadowStyle; ° d ONLN d™-å9¯ )Z/* Shadow style */ ° d ONLN dΩ-
9 )~\ ° d ONLN d¿8 êD ∫ (A êBoolean ° d ONLN d»8 ΔDt )6 noOutlineStyle, outlineStyle; ° d ONLN dÁ8åD˛ )Δ/* Outline style */ ° d ONLN d˚8
D )~\ ° d ONLN d˛C êO ∫ (L êBoolean ° d ONLN d C ΔO )67noUnderlineStyle, underlineStyle;/* Underline style */\ ° d ONLN d ?N êZ ∫ (W êBoolean ° d ONLN d GN ΔZh )6noItalicStyle, italicStyle; ° d ONLN d dNåZ¯ )Δ/* Italic style */ ° d ONLN d wN
Z )~\ ° d ONLN d zY êe ∫ (b êBoolean ° d ONLN d ÇY ΔeP )6noBoldStyle, boldStyle; ° d ONLN d ùYåeÏ )Δ/* Bold style */ ° d ONLN d Æo ~{ (x ~#define fontFamilyAtomFlags ° d ONLN d ÷o
{ (x
\ ° d ONLN d ⁄z ¢Ü à (É ¢boolean ° d ONLN d „z ÍÜÏ )H+dontDeleteWhenRemoving, deleteWhenRemoving; ° d ONLN d
z
Ü (É
\ ° d ONLN d
Ö ¢ë à (é ¢boolean ° d ONLN d
Ö Íë )H/dontDeleteWhenInstalling, deleteWhenInstalling; ° d ONLN d
MÖ
ë (é
\ ° d ONLN d
Qê ¢ú Ã (ô ¢boolean ° d ONLN d
Zê ÍúD )HdontCopy, copy; ° d ONLN d
tê
ú (ô
\ ° d ONLN d
xõ ¢ß ‰ (§ ¢ fill bit[5] ° d ONLN d
çõå߇ )Í/* Reserved */ ° d ONLN d
ûõ
ß )~\ ° d ONLN d
¢¶ ¢≤ à (Ø ¢boolean ° d ONLN d
´¶ Í≤º )H#noEncodedFONDRsrc, encodedFONDRsrc; ° d ONLN d
Ӧ
≤ (Ø
\ ° d ONLN d
◊± ¢Ω à (∫ ¢boolean ° d ONLN d
‡± ÍΩå )HnoTgtRequired, tgtRequired; ° d ONLN d ±
Ω (∫
\ ° d ONLN d º ¢» à (≈ ¢boolean ° d ONLN d º Í»ò )H updateExisting, keepExisting; ° d ONLN d 3º
» (≈
\ ° d ONLN d 7« ¢” Ã (– ¢boolean ° d ONLN d @« Í”™ )H copyIfNewOrUpdate, copyIfUpdate; ° d ONLN d f«
” (–
\ ° d ONLN d j“ ¢fi à (€ ¢boolean ° d ONLN d s“ Ífi‘ )H'dontIgnoreProtection, ignoreProtection; ° d ONLN d ù“
° d ONLN d Q ¢ ] Ã ( Z ¢boolean ° d ONLN d Q Í ]û )H srcNeedExist, srcNeedNotExist; ° d ONLN d - Q
] ( Z
\ ° d ONLN d 1 \ ¢ h à ( e ¢boolean ° d ONLN d : \ Í h8 )H
byName, byID; ° d ONLN d S \
h ( e
\ ° d ONLN d W g ¢ s à ( p ¢boolean ° d ONLN d ` g Í s§ )H nameNeedNotMatch, nameMustMatch ° d ONLN d Ä } ~ â ® ( Ü ~#define ° d ONLN d à } ¥ â ‰ )6RsrcSpec ° d ONLN d ° }
â ( Ü
\ ° d ONLN d • à ¢ î ‰ ( ë ¢ fileSpecID; ° d ONLN d µ à2 î‡ )ê /* Source Piece File Spec. */ ° d ONLN d ’ à
î )ÿ\ ° d ONLN d Ÿ ì ¢ ü ÿ ( ú ¢ rsrcType; ° d ONLN d Á ì2 ü» )ê/* Source Piece Rsrc Type ° d ONLN d ì‘ ü‡ )¢*/ ° d ONLN d ì
ü )6\ ° d ONLN d
û ¢ ™ à ( ß ¢rsrcID; ° d ONLN d û2 ™Œ )ê/* Source Piece Rsrc ID */ ° d ONLN d5 û
µ )ÿ\ ° d ONLN dp ¥ ¢ ¿ ( Ω ¢evenPaddedString ° d ONLN dÉ ¥2 ¿⁄ )ê /* Source Piece Rsrc Name */ ° d ONLN d§ ~ ÷ ® ( ” ~#define ° d ONLN d¨ ¥ ÷ ¸ )6 SrcPartsList ° d ONLN d«
÷ ( ”
\ ° d ONLN dÀ ’ ¢ ·˛ ( fi ¢:integer = $$CountOf (Pieces);/* Number of source pieces */ ° d ONLN d ’
· ( fi
\ ° d ONLN d
‡ ¢ Ï ( È ¢wide array Pieces{ ° d ONLN d* ‡
Ï ( È
\ ° d ONLN d/ Î ¥ ˜ Í ( Ù ¥ RsrcSpec; ° d ONLN d= ÎD ˜¯ )ê /* Description of this piece*/ ° d ONLN d\ Î
˜ )Δ\ ° d ONLN d` ˆ ¢ ® ( ˇ ¢} ° d ONLN db ~ “ ( ~#define Strike ° d ONLN dÇ
(
\ ° d ONLN dÖ ê# ¿ ( êinteger; ° d ONLN dì #z )ê/* Font Size */ ° d ONLN d™
# )Í\ ° d ONLN d≠" ê. ¥ (+ êStyle; ° d ONLN dπ" .Ä )ê/* Font Style */ ° d ONLN d—"
. )Í\ ° d ONLN d‘- ê9 Δ (6 ê RsrcType; ° d ONLN d‚- 9⁄ )ê /* Target Font Resource Type */ ° d ONLN d-
9 )Í\ ° d ONLN d8 êD ¿ (A êinteger; ° d ONLN d8 D™ )ê/* Target Attributes */ ° d ONLN d28
D )Í\ ° d ONLN d5C êO fi (L ê
SrcPartsList; ° d ONLN dFC O» )ê /* Optional source pieces */ ° d ONLN deY ~e à (b ~
type 'inff' { ° d ONLN dtd êp ¿ + switch { ° d ONLN do ¢{ +
case format2: ° d ONLN dêz ¥Ü + key integer = 2; ° d ONLN d£zDܬ )ê/*format version 2 */ ° d ONLN dºÖ ¥ë, (é ¥fontFamilyAtomFlags; ° d ONLN d“ÖDë¬ )ê/* Font Atom Flags */ ° d ONLN dÎê ¥ú ˆ (ô ¥ fileSpecID; ° d ONLN d˚êDú» )ê/* Target File Spec */ ° d ONLN dõ ¥ß ˆ (§ ¥ fileSpecID; ° d ONLN d%õDßÊ )ê/* FOND Source File Spec */ ° d ONLN dD¶ ¥≤ ‰ (Ø ¥integer; ° d ONLN dR¶D≤Ï )ê /* Target FOND Attributes */ ° d ONLN dr± ¥Ω (∫ ¥unsigned longInt; ° d ONLN dܱDΩ™ )ê/* Family Size */ ° d ONLN dõº ¥» fi (≈ ¥rsrcID; ° d ONLN d®ºD»‡ )ê/* Target Family Number */ ° d ONLN dΔ« ¥” ‰ (– ¥switch { ° d ONLN d““ ¥fi * case entireFamily: ° d ONLN dË› ¥È ∫ * ° d ONLN dÍ› ΔÈ& )key integer = 1; ° d ONLN d˛Ë ¥ÙV (Ò ¥case explicitFamilyMembers: ° d ONLN d Û Δˇ& + key integer = 2; ° d ONLN d3˛ Δ
Œ * ,unsigned integer = $$CountOf(StrikeEntries); ° d ONLN dd Δb * wide array StrikeEntries { ° d ONLN dÑ ÿ + Strike; ° d ONLN dèD )l$/* Source for each of the strikes */ ° d ONLN d∏ Δ+ “ (( Δ}; ° d ONLN dæ* ¥6 ¿ (3 ¥}; ° d ONLN dƒ5 ¥A fi * rsrcID; ° d ONLN d—5DA» )ê/* Atom Extender ID */ ° d ONLN dÎ@ ¥L (I ¥evenPaddedString; ° d ONLN dˇ@DL» )ê/* Atom Description */ ° d ONLN dK ¥W (T ¥evenPaddedString; ° d ONLN d-KDW™ )ê/* Family Name */ ° d ONLN d@V êb ú (_ ê}; ° d ONLN dCa ~m ä (j ~};
° d ONLN dF} ~à ’ *Flag Descriptions
° d ONLN dXã ~ót *)deleteWhenRemoving/dontDeleteWhenRemoving ° d ONLN dÉñ¢ +ê ;Determines if specific font strikes or the entire family is ° d ONLN dø¢ÆÉ * deleted during a removal. ° d ONLN d⁄∂¬C * Using with ° d ONLN dÂ∂C¬÷ )5explicitFamilyMembers ° d ONLN d˙∂÷¬ )ì copy option ° d ONLN d¬Œd (À— When using the ° d ONLN d¬dŒ– )VdeleteWhenRemoving ° d ONLN d*¬–Œ" )l flag, if the target ° d ONLN d?Œ⁄
(◊;font strike exists and the user clicks Remove the strike is ˇ d ˇ ˇˇˇˇ d
° d ONLN d Q ], ( ZEdeleted. If a strike does not exist on the target disk, this flag is ° d ONLN d F ] i' * Aignored. If all font strikes for a given family are removed, the ° d ONLN d à i u… * )family’s ‘FOND’ resource is also deleted. ° d ONLN d µ } âC * Using with ,
(;font strike exists and the user clicks Remove the strike is ° d ONLN dÌ$, * Edeleted. If a strike does not exist on the target disk, this flag is ° d ONLN d3$0' * Aignored. If all font strikes for a given family are removed, the ° d ONLN du0<… * )family’s ‘FOND’ resource is also deleted. ° d ONLN d¢DPC * Using with ° d ONLN d≠DCPó )5 entireFamily ° d ONLN dπDóPÕ )T copy option ° d ONLN d≈DÕP# )6 — When using the ° d ONLN d◊P\z (YdeleteWhenRemoving ° d ONLN dÈPz\- )l' flag, the family’s ‘FOND’ resource and ° d ONLN d\h (eall ° d ONLN d\ hœ )* font strikes for the family are deleted. ° d ONLN d@p|" (yThe ° d ONLN dDp"|ö )deleteWhenInstalling ° d ONLN dXpö| )x flag is primarily used for ° d ONLN dt|à# (Ö?deleting previously installed font resources that are no longer ° d ONLN d¥àî1 * needed. ° d ONLN dºú ~® à (• ~
copy/dontCopy ° d ONLN d ú® )ê<Determines if the font resources are copied or not during an ° d ONLN d®¥± * %installation. Note that some flags ( ° d ONLN d,®±¥ )£leaveAloneIfNewer ° d ONLN d=®¥ )f, ° d ONLN d?¥¿V (Ω keepExisting ° d ONLN dK¥V¿[ )H, ° d ONLN dM¥[¿£ ) copyIfUpdate ° d ONLN dY¥£¿ )H) can prevent copying from ° d ONLN dt¿Ã⁄ (…,happening under the circumstances specified. ° d ONLN d£‘ ~‡D (› ~!noEncodedFONDRsrc/encodedFONDRsrc ° d ONLN d≈flÎ +ê <Allows ‘FOND’ resources to be encoded into the resource type ° d ONLN dΘ٠* 3‘iFND’ when compessing the font resources. This is ° d ONLN d6˜ * 4recommended to help prevent the system software from ° d ONLN dk * 8becoming confused when finding a ‘FOND’ resource in your ° d ONLN d§ * ;source file that may reference not existent font resources. ° d ONLN d‡# ~/ (, ~tgtRequired/noTgtRequired ° d ONLN d˙.: +ê @The target file must already exist. If the target file does not ° d ONLN d;:F * =exist, the user is warned that a target file is needed. When ° d ONLN dyFR9 *
using the ° d ONLN dÉF9Rá )+
noTgtRequired ° d ONLN dêFáR )N" flag and the target file does not ° d ONLN d≥R^´ ([%exist, the Installer will create one. ° d ONLN dŸf ~r (o ~keepExisting/updateExisting ° d ONLN dıq}- +ê @Allows the scriptwriter to preserve existing font resources when ° d ONLN d6}â9 *
using the ° d ONLN d@}9âQ )+copy ° d ONLN dD}Qât ) and/or ° d ONLN dL}t⌠)#deleteOnInstall ° d ONLN d[}Œâ
Courier ° d ONLN d QC ]ó )5 entireFamily ° d ONLN d Qó ]Õ )T copy option ° d ONLN d # QÕ ]# )6 — When using the ° d ONLN d 5 ] iV ( f keepExisting ° d ONLN d A ]V i# )H- flag and the ‘FOND’ resource already exists, ° d ONLN d o i u≥ ( r&no strikes will be copied or replaced. ° d ONLN d ô } âç * No copying will occur if the ° d ONLN d ∂ }ç â· )updateExisting ° d ONLN d ƒ }· â )T
® ¥ +ê <Allows the scriptwriter to update a font resource only if it ° d ONLN dJ ¥ ¿{ * already exists. Use the ° d ONLN dc ¥{ ¿√ )m copyIfUpdate ° d ONLN do ¥√ ¿$ )H flag to prevent a new ° d ONLN dÜ ¿ Ãä ( … resource from being created. ° d ONLN d¶ ‘ ‡C * Using with ° d ONLN d± ‘C ‡÷ )5explicitFamilyMembers ° d ONLN dΔ ‘÷ ‡ )ì copy option ° d ONLN d” ‡ Ïd ( È— When using the ° d ONLN d‰ ‡d Ϩ )V copyIfUpdate ° d ONLN d ‡¨ Ï )H flag, a specific strike is ° d ONLN d Ï ¯) ( ıBcopied to the target file only if the strike already exists in the ° d ONLN dO ¯@ * target file. ° d ONLN d^ C * Using with ° d ONLN di Có )5 entireFamily ° d ONLN du óÕ )T copy option ° d ONLN dÅ Õ( )6 — The entire source ° d ONLN dñ$+ (!Cfont family will be copied if any strikes exist in the target file. ° d ONLN d‹,8* *If the ° d ONLN d„,*8r ) copyIfUpdate ° d ONLN dÔ,r8‘ )H flag is used with the ° d ONLN d,‘8 )b keepExisting ° d ONLN d8Dù (A!flag, then no copying will occur. ° d ONLN d5L ~X\ (U ~%ignoreProtection/dontIgnoreProtection ° d ONLN d[Wc +ê =Determines if the user should be alerted if any font resource ° d ONLN dôco˝ * 7with its protected bit set will be replaced or deleted. ° d ONLN d‘wÉC * Using with ° d ONLN dflwCÉ÷ )5explicitFamilyMembers ° d ONLN dÙw÷É )ì copy option ° d ONLN dÉèd (å— When using the ° d ONLN dÉdè‹ )VdontIgnoreProtection ° d ONLN d&É‹è )x
flag, if the ° d ONLN d4èõ (ò;‘FOND’ resource or any font resource to be replaced has the ° d ONLN dpõߘ * 6protection flag set, the user will be alerted, and the ° d ONLN dßß≥∫ * 'installation will be canceled. Use the ° d ONLN dœ≥øÜ * dontIgnoreProtection ° d ONLN d„≥Üø )x" flag if preserving protected font ° d ONLN døÀ¿ (»(resources is important. When using the ° d ONLN d.ø¿À )≤ignoreProtection ° d ONLN d?À◊, (‘Aflag the font resources are deleted from or updated in the target ° d ONLN dÅ◊„Ï * 5file even if it any are protected in the target file. ° d ONLN d∏ΘC * Using with ° d ONLN d√ÎC˜ó )5 entireFamily ° d ONLN dœÎó˜Õ )T copy option ° d ONLN d€ÎÕ˜# )6 — When using the ° d ONLN dÌ˜Ü ( dontIgnoreProtection ° d ONLN d˜Ü! )x% flag the user is alerted only if the ° d ONLN d'* ( A‘FOND’ resource is protected, but if any other font resources are ° d ONLN di * ;protected, they will be replaced without alerting the user. ° d ONLN d¶'W * When using the ° d ONLN dµW'∑ )IignoreProtection ° d ONLN d≈∑'- )` flag the font resources are ° d ONLN d‚'3 (0=deleted from or updated in the target file even if it any are ° d ONLN d 3?ä * protected in the target file. ° d ONLN d>G ~S& (P ~ srcNeedExist/srcNeedNotExist ° d ONLN d[R^& +ê >Determines whether the source font resources must exist on the ° d ONLN dö^jk * source disk. Use the ° d ONLN d∞^kj≈ )]srcNeedNotExist ° d ONLN dø^≈j )Z flag if the source ° d ONLN d”jv' (sBresources can optionally reside on the source disk. If the source ° d ONLN dvÇ& * Bfile or source resources are not found, the atom it is ignored and ° d ONLN dYÇé± * $the installation continues normally. ° d ONLN d~ñ ~¢ ¿ (ü ~ byID/byName ° d ONLN däñ¢* )ê?Determines how the font strike resources should be found in the ° d ONLN d ¢Æz * source files. If using the ° d ONLN d¢zÆí )lbyID ° d ONLN dÈ¢íÆ, )% flag the font strike’s resources are ° d ONLN d Æ∫* (∑Cfound in the source file using only the ID. If you want to require ° d ONLN d S∫Δ‰ * /the resource name to match as well then use the ° d ONLN d ÉΔ“\ *
nameMustMatch ° d ONLN d êΔ\“∫ )N flag. Note that the ° d ONLN d ¶Δ∫““ )^byID ° d ONLN d ™Δ““ ) flag can only be ° d ONLN d º“fiô (€ used when installing using the ° d ONLN d €“ôfi )ãexplicitFamilyMembers ° d ONLN d “fi. )~ copy ˇÓ d ˇ ˇˇˇˇ d
° d ONLN d Q ] ( Z>option and split source resources are specified. If using the ,
Courier ° d ONLN d ? ] i2 * byName ° d ONLN d E ]2 i- )$< flag the font strike resources are found in the source file ° d ONLN d Ç i u≤ ( r%using only the name specified in the ° d ONLN d ß i≤ u )§Source Piece Rsrc ° d ONLN d π u Å& ( ~Name ° d ONLN d Ω u& ÅB ) field. ° d ONLN d ≈ â ~ ï2 ( í ~ nameMustMatch/nameNeedNotMatch ° d ONLN d ‰ î † +ê ?Specifies if the font strike resources found in the source file ° d ONLN d$ † ¨Õ * *using their IDs must have the name in the ° d ONLN dN †Õ ¨ )ø Source Piece ° d ONLN d[ ¨ ∏D ( µ Rsrc Name ° d ONLN dd ¨D ∏¶ )6 field. Note that the ° d ONLN d{ ¨¶ ∏Ù )b
nameMustMatch ° d ONLN dà ¨Ù ∏ )N flag can ° d ONLN dí ∏ ƒπ ( ¡&only be used when installing using the ° d ONLN dπ ƒ –å * explicitFamilyMembers ° d ONLN dŒ ƒå –
)~ copy option and split source ° d ONLN dÏ – ‹ ( Ÿ6resources are specified. This flag is ignored if the ° d ONLN d" – ‹ )‚byName ° d ONLN d( – ‹) )$ flag ° d ONLN d. ‹ Ë/ ( Âis used.
° d ONLN d7 Ú ~ ˝ ÿ ( ˙ ~Field Descriptions
° d ONLN dJ ~ *Target File Spec ID ° d ONLN d^ )êAThe resource ID of a Target File Spec script resource (‘intf’, or ° d ONLN d† ! * B‘infs’ for pre-4,0 scripts) describing the file on the target disk ° d ONLN d„$ * <where the resource will be deleted, created, or updated. (2 ° d ONLN d $ (!- ° d ONLN d $0* (-bytes) ° d ONLN d(8 ~D (A ~Source File Spec ID ° d ONLN d<8D$ )ê@The resource ID of a Source File Spec script resource describing ° d ONLN d}DP* * @the file on the source disk that contains the 'FOND' resource to ° d ONLN dæP\í * be copied into the target file. ° d ONLN d‡dpC * Using with ° d ONLN dÎdCp÷ )5explicitFamilyMembers ° d ONLN d d÷p )ì copy option ° d ONLN d d p# )6 — If ° d ONLN dp| (y=no optional split source information is provided, the strikes ° d ONLN dP|à" * ?specified must also be contained in the same file as the source ° d ONLN dêàî * :‘FOND’ resource. Optional split source information always ° d ONLN dÀî† * <overrides that default source for those strikes that use it. ° d ONLN d ®¥C * Using with ° d ONLN d®C¥ó )5 entireFamily ° d ONLN d ®ó¥Õ )T copy option ° d ONLN d,®Õ¥( )6 — The source strike ° d ONLN dA¥¿ (Ω:resources referenced in the source 'FOND' resource must be ° d ONLN d|¿Ã+ * @contained in the same source file as the source 'FOND' resource. ° d ONLN d¿‘‡# *AIf you’re just deleting strikes and therefore don’t need a source ° d ONLN d‡Ï° * %file, set this field to 0. (2-bytes) ° d ONLN d(Ù ~ (˝ ~Target FOND Attributes ° d ONLN d?Ù + )ê?The resource attributes that will be given to the target 'FOND' ° d ONLN d ( * @resource during installation. See Inside Macintosh Vol. I, page ° d ONLN d¿ * >111 for more information about resource attributes. (2-bytes) ° d ONLN dˇ ~, fi () ~Font Family Size ° d ONLN d , )ê<The size in bytes of all font resources including the 'FOND' ° d ONLN dM,8 * ?resource to be installed or deleted. This field is used by the ° d ONLN dç8D * ?Installer in figuring the sizes for an installation. (4-bytes) ° d ONLN dÕL ~X “ (U ~Target FOND ID ° d ONLN d‹LX
)ê7The resource ID that will be given to the target 'FOND' ° d ONLN dXd& * >resource. Normally, this ID should also be the same ID as the ° d ONLN dSdp. * @resource ID of the source 'FOND' resource. The Installer always ° d ONLN dîp|& * =sets the family number field contained in the ‘FOND’ resource ° d ONLN d“|à& * >to the resource ID of the ‘FOND’ when it is copied or updated. ° d ONLN d àî7 * (2-bytes) ° d ONLN d ú ~® ¸ (• ~How-To-Copy Value Key ° d ONLN d 2ú® )ê<Specifies how the font resources will be copied, or deleted. ° d ONLN d o®¥‰ * 0Currently, the two copy options are available: ° d ONLN d ü®‰¥, )÷ entireFamily ° d ONLN d ¨¥¿Q (ΩValue (1), and ° d ONLN d ª¥Q¿œ )CexplicitFamilyMembers ° d ONLN d –¥œ¿, )~ Value (2). (2-bytes) ° d ONLN d Ë»‘< (—
Using the ° d ONLN d Ú»<‘ê ). entireFamily ° d ONLN d ˛»ê‘Δ )T copy option ° d ONLN d
»Δ‘( )6 — Tells the Installer ° d ONLN d
!‘‡) (›@that all strikes specified in the source 'FOND' resource will be ˇF d ˇ ˇˇˇˇ d
° d ONLN d Q ] ( Z>copied. The 'FONT', 'NFNT', or 'sfnt' resources must exist in ° d ONLN d ? ] i# * =the same source file as the 'FOND' resource. The Copy Entire ° d ONLN d } i u# * <Family Value is provided to copy small, simple font families ° d ONLN d ∫ u Å * 9with minimal scripting effort. Since the target resource ° d ONLN d Ù Å ç$ * @attributes cannot be specified, the target resource inherits the ° d ONLN d5 ç ô * 4source's. If the Font Family Atom Flags are set for ,
Courier ° d ONLN dj ô •Ä * deleteWhenRemoving ° d ONLN d} ôÄ •ã )ror ° d ONLN dÄ ôã • ) deleteWhenInstalling & ° d ONLN dó • ±> ( ÆdontCopy ° d ONLN dü •> ±. )05 the target 'FOND' resource and ALL of its referenced ° d ONLN d’ ± Ω ( ∫<strikes will be deleted from the target file upon removal or ° d ONLN d Ω …u * installation. (2-bytes) ° d ONLN d, — ›< *
Using the ° d ONLN d6 —< ›œ ).explicitFamilyMembers ° d ONLN dK —œ › )ì copy option ° d ONLN dW — ›+ )6 — Tells ° d ONLN d` › È ( Ê;the Installer that one or more strikes are specified in the ° d ONLN dú È ı° * !following member list. (2-bytes) ° d ONLN dæ ˝ ~ ∫ ( ~
Point Size ° d ONLN d» ˝ ∫ º )< ° d ONLN d ˝ Ã )T*The family member's point size. (2-bytes) ° d ONLN dı ~ ú ( ~Style ° d ONLN d˙ ú û ) ° d ONLN d¸ )r@Contains flags describing the style of the font. The style bits ° d ONLN d= )è * are defined below. (2-bytes) ° d ONLN d[)5' * Bit 0: ° d ONLN db)25h )$ Set for Bold ° d ONLN do5A' (>Bit 1: ° d ONLN dv52Al )$Set for Italic ° d ONLN dÖAM' (JBit 2: ° d ONLN dåA2MÄ )$Set for Underline ° d ONLN dûMY' (VBit 3: ° d ONLN d•M2Yu )$Set for Outline ° d ONLN dµYe' (bBit 4: ° d ONLN dºY2ex )$Set for Shadow ° d ONLN dÀeq' (nBit 5: ° d ONLN d“e2qÇ )$Set for Condensed ° d ONLN d‰q}' (zBit 6: ° d ONLN dÎq2}q )$Set for Extend ° d ONLN d˙}ââ (Ü All other bits are reserved. ° d ONLN dë ~ù Ã (ö ~
). (4-bytes) ° d ONLN dG’ ~· (fi ~Resource Attributes ° d ONLN d[’· )ê=The resource attributes that will be given to the target font ° d ONLN dô·Ì( * Bresource. The Split Resource list specifies one or more resources ° d ONLN d‹Ì˘ * 9that make up the font resource when combined in the order ° d ONLN d˘Y * listed. (2-bytes) ° d ONLN d)
~ ( ~Split Resource File Spec ID ° d ONLN dE$ +ê <The Split Resource File Spec ID field is a 2-byte field that ° d ONLN dÇ$0 * =specifies the file on the source disk that contains the split ° d ONLN d¿0<• * #resource to be combined. (2-bytes) ° d ONLN d‰D ~P (M ~Split Resource Type ° d ONLN d¯DP )ê>The resource type of the source split resource. Usually, this ° d ONLN d7P\ú * !should be type 'part'. (4-bytes) ° d ONLN dYd ~p ‰ (m ~Split Resource ID ° d ONLN dkdp¸ )ê8The resource ID of the source split resource. (2-bytes) ° d ONLN d§x ~Ñ (Å ~Split Resource Size ° d ONLN d∏xÑ )ê@The exact size in bytes of the source split resource. (4-bytes) ° d ONLN d˘å ~ò (ï ~Split Resource Name ° d ONLN d
åò )ê@The name of the source split resource. If the resource is being ° d ONLN dNò§T * found using the ° d ONLN d^òT§x )FbyName ° d ONLN ddòx§( )$* flag, this field must be filled. To help ° d ONLN dè§∞# (≠@ensure that the correct resource is being installed, the name of ° d ONLN d–∞º * <the resource in the source file must match this field if the ° d ONLN d
º» * =resource is being found by name. (even-padded Pascal string) ˇ¥ d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ] fi ( Z ~Atom Extender ID ° d ONLN d Q ]* )êAThe resource ID of an Atom Extender ‘inex’ script resource. This ° d ONLN d S ] i
* 8Atom Extender will be called during copying of each font ° d ONLN d å i ux * resource part. (2-bytes) ° d ONLN d ¶ } ~ â& ( Ü ~ Font Family Atom Description ° d ONLN d √ à î$ +ê @A Pascal string describing the atom. This field is used as part ° d ONLN d î †. * Dof the status dialog. If this field is not empty, the status dialog ° d ONLN dI † ¨ * 4displays “Reading <Description String>”, or “Writing ° d ONLN d~ ¨ ∏, * A<Description String>”. If this field is empty, the status dialog ° d ONLN d¿ ∏ ƒ * 8displays “Reading font: <Font Family Name>”, or “Writing ° d ONLN d˘ ƒ – * 7font: <Font Family Name>”. (even-padded Pascal string) ° d ONLN d1 ÿ ~ ‰ fi ( · ~Font Family Name ° d ONLN dB ÿ ‰ )ê:The family name. The family name will be used to find the ° d ONLN d} ‰ . * ?source and target 'FOND' resource. (even-padded Pascal string)
° d ONLN dΩ 6 W ( 6 About the ResMerge Atom (‘inrm’) " ° ∂ 4 0 ° ∂ ° ∂
° d ONLN dfi! ~- +H^The ResMerge Atom can be used to copy all resources from a source file to a target file. Each ° d ONLN d=- ~9" * _resource is copied separately, replacing an existing resource of the same type and ID. Because ° d ONLN dù9 ~E * Vthe ResMerge Atom offers no options, you may find that you will need to use individual ° d ONLN dÙE ~QG * ,Resource Atoms to handle special situations. ° d ONLN d!Y ~e *YThe ResMerge Atom is unique from using Resource Atoms because anyone can add to or delete ° d ONLN d{e ~q * \resources from the source file without changing the atom. This is acceptable as long as the ° d ONLN dÿq ~}+ * bInstaller can successfully preflight the required disk space. A field in the atom holds the total ° d ONLN d;} ~â" * dsize the resources expect to occupy in the target file. This flexibility comes at a cost to ease of ° d ONLN d†â ~ï * Yuse because the Installer cannot determine during preflighting how many resources will be ° d ONLN d˙ï ~°- * _replaced, thus not requiring additional disk space. We will therefore usually overestimate the ° d ONLN dZ° ~≠
* Xrequired disk space, forcing the user to make more space available than will probably be ° d ONLN d≥≠ ~π ¨ *
necessary.
° d ONLN dæ— 6Â (‡ 6Using the ResMerge Atom " ° ∂ Â 4Â0 ° ∂ ° ∂
° d ONLN d÷Í ~ˆ +HVThe ResMerge Atom offers limited options, so determining when to use the ResMerge Atom ° d ONLN d-ˆ ~+ * ]versus separate Resource Atoms or a File Atom is important. The main purpose of the ResMerge ° d ONLN dã ~¸ * RAtom is to provide a simple high-level resource copy mechanism without forcing the ° d ONLN dfi ~T * /scriptwriter to create numerous Resource Atoms. ° d ONLN d" ~.' *[The Installer executes a ResMerge Atom by automatically converting the atom into individual ° d ONLN dj. ~:* * _Resource Atoms when the Installer is ready to begin reading from the source disk. The Resource ° d ONLN d : ~F: * )Atom is created with the following flags: ,
Zapf Dingbats
° d ONLN dÙP ~Y Ö *n
° d ONLN dˆN êZ )IdontDeleteWhenRemoving — The ResMerge Atom does nothing during a removal.
° d ONLN d @d ~m Ö (k ~n
° d ONLN d Bb ên )dontDeleteWhenInstalling.
° d ONLN d \x ~Å Ö ( ~n
° d ONLN d ^v êÇ ® )copy.
° d ONLN d då ~ï Ö (ì ~n
° d ONLN d fä êñ )MnoTgtRequired — The target file will be created if it does not already exist.
e ê q- )UnameNeedNotMatch — The name is ignored, but the new name will replace the old name if ° d ONLN d ` q ê } º *
different.
° d ONLN d k á ~ í ö ( è ~NOTE
° d ONLN d p ï ~ °% *[System Software scriptwriters must use care when using the ResMerge Atom because on pre-7.0 ° d ONLN d à ° ~ ≠
* Wsystems we determine if the Folder Manager will be available based on the presence of a ° d ONLN d$ ≠ ~ π& * \Resource Atom copying a ‘fld#’ resource. This means a separate Resource Atom must always be ° d ONLN dÅ π ~ ≈% * (created to install the ‘fld#’ resource.
° d ONLN d´ › 6 Ò ( Ï 6ResMerge Atom Reference " ° ∂ Ò 4 Ò0 ° ∂ ° ∂
° d ONLN d√ ˆ ~ +HHThe format of the ResMerge Atom is simple. Its template is shown below. ,
Courier ° d ONLN d ~ ® * #define ° d ONLN d ¥ )6resMergeAtomFlags ° d ONLN d2¯ ˛ (¯\ ° d ONLN d6 ¢) (& ¢
fill bit[16]; ° d ONLN dD3 ~? Ã (< ~
type 'inrm' { ° d ONLN dT> ¢J “ +$ switch { ° d ONLN d`I ¥U +
case format0: ° d ONLN drT Δ`& + key integer = 0; ° d ONLN dÖTV`" )ê"/* ResMerge Atom Format version */ ° d ONLN d¨_ Δk (h ΔmergeAtomFlags; ° d ONLN dæ_VkÏ )ê/* ResMerge Atom Flags */ ° d ONLN d‹j Δv, (s Δunsigned longInt; ° d ONLN djVvÚ )ê/* Total Resources Size */ ° d ONLN du ΔÅ (~ Δ fileSpecID; ° d ONLN d uVÅ )ê /* Target File Spec. Rsrc ID */ ° d ONLN dCÄ Δå (â Δ fileSpecID; ° d ONLN dSÄVå )ê /* Source File Spec. Rsrc ID */ ° d ONLN dwã Δó, (î ΔevenPaddedString; ° d ONLN dããVóÊ )ê/* Status Description */ ° d ONLN dßñ ¢¢ Æ (ü ¢}; ° d ONLN d™° ~≠ ä (™ ~};
° d ONLN d≠Ω ~» ◊ *Field descriptions
° d ONLN d¡À ~◊ *ResMerge Atom Flags ° d ONLN d‘À ◊ Ú )r ° d ONLN d÷À◊ ) =Currently reserved for use by Apple Computer, Inc. (2-bytes) ° d ONLN dfl ~Î ¸ (Ë ~Total Resources Size ° d ONLN d*flÎ )ê@The size that all resources will occupy in the target file. For ° d ONLN dkΘ * @most purposes, the size of the source file’s resource fork is an ° d ONLN d¨˜( * Aadequate estimate. This field is used by the Installer to figure ° d ONLN dÓ’ * -the amount of disk space required. (4-bytes) ° d ONLN d ~# ( ~Target File Spec. Rsrc ID ° d ONLN d7". +ê >The resource ID of a Target File Spec (‘intf’) script resource ° d ONLN dv.: * >describing the desired location of the target file. (2-bytes) ° d ONLN dµB ~N (K ~Source File Spec. Rsrc ID ° d ONLN d–MY +ê >The resource ID of a Source File Spec (‘infs’) script resource ° d ONLN dYeÚ * 6describing the location of the source file. (2-bytes) ° d ONLN dFm ~y Í (v ~Status Description ° d ONLN dYmy- )ê@An optional string that is displayed in the Status dialog during ° d ONLN döyÖ# * ;execution of the ResMerge Atom. (even-padded Pascal string)
° d ONLN d◊ù 6±5 (¨ 6 About the Folder Atom (‘infm’) " ° ∂ ± 4±0 ° ∂ ° ∂
° d ONLN dˆ∂ ~¬ +H`The Folder Atom can be used to copy all files from the root-level of a source folder to the root ° d ONLN dV∂ ¬# (ø - ° d ONLN dW¬ ~Œ (À ~alevel of a target folder. Each file is copied separately, replacing an existing file of the same ° d ONLN dπŒ ~⁄ * ]name. Folders within the source folder are ignored, and must be copied using separate Folder ˇ6 d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ] ( Z ~YAtoms. Because the Folder Atom offers no options, you may find that you will need to use ° d ONLN d Z ] ~ iå * <individual Resource Atoms to copy some or all the resources. ° d ONLN d ó q ~ }& *^The Folder Atom is unique from using File Atoms because anyone can add to or delete files from ° d ONLN d ˆ } ~ ⯠* Uthe source folder without changing the atom. This is OK as long as the Installer can ° d ONLN dL â ~ ï * ]successfully preflight the required disk space. A field in the atom holds the total size the ° d ONLN d™ ï ~ °- * esource files. This flexibility comes at a cost to ease of use because the Installer cannot determine ° d ONLN d ° ~ ≠& * ^during preflighting how many files will be replaced, thus not requiring additional disk space. ° d ONLN dp ≠ ~ π& * ]We will therefore usually overestimate the required disk space, forcing the user to make more ° d ONLN dŒ π ~ ≈\ * 0space available than will probably be necessary.
° d ONLN dˇ œ ~ ⁄ ö *NOTE
° d ONLN d › ~ È- *bThe Folder Atom only copies the files at the root level of the source folder. Nested folders must ° d ONLN dg È ~ ıo * 4be copied separately with additional Folder Atoms. ,
Zapf Dingbats
° d ONLN dõ Îo Ùv )Òu
° d ONLN dù
6! Ú ( 6Using the Folder Atom " ° ∂ ! 4!0 ° ∂ ° ∂
° d ONLN d≥& ~2( +H]The Folder Atom offers no options, so determining when to use the Folder Atom versus separate ° d ONLN d2 ~> * YFile Atoms is important. The main purpose of the Folder Atom is to provide a simple high ° d ONLN dj2> (;- ° d ONLN dk> ~J) (G ~^level file copy mechanism without forcing the scriptwriter to create numerous File Atoms. The ° d ONLN d J ~V™ * AFolder Atom does not support decompression or version comparison. ° d ONLN d ^ ~j. *^The Installer executes a Folder Atom by automatically converting the atom into individual File ° d ONLN dkj ~v * \Atoms when the Installer is ready to begin reading from the source folder. The File Atom is ° d ONLN d»v ~Ç * !created with the following flags:
° d ONLN dÍå ~ï Ö *n
° d ONLN dÏä êñÙ )GdontDeleteWhenRemoving — The Folder Atom does nothing during a removal.
° d ONLN dZΔ ê“) )[dontIgnoreLockedFile — The user is notified about locked target files, and the installation ° d ONLN d∂“ êfi ¡ * is stopped.
° d ONLN d¬Ë ~Ò Ö (Ô ~n
° d ONLN dƒÊ êÚ. )_dontSetFileLocked or setFileLocked — If the source file is locked it will be locked after it is ° d ONLN d$Ú ê˛ ± * copied.
° d ONLN d, ~ Ö ( ~n
° d ONLN d. ê˘ )LuseSrcCrDateToCompare — Since no version compare procedure can be specified.
° d ONLN d{ ~% Ö (# ~n
° d ONLN d} ê&, )[srcNeedNotExist — Doesn’t really matter because if it didn’t exist we would not be creating ° d ONLN dŸ& ê2 * this File Atom to copy it.
° d ONLN dÙ< ~E Ö (C ~n
° d ONLN dˆ: êFê )7rsrcForkInRsrcFork — Since no decompression is allowed.
° d ONLN d.P ~Y Ö (W ~n
° d ONLN d0N êZÃ )DupdateExisting — Existing files with the same name will be replaced.
° d ONLN dud ~m Ö (k ~n
° d ONLN dwb ên ı )copyIfNewOrUpdate.
° d ONLN däx ~Å Ö ( ~n
° d ONLN dåv êÇI )+rsrcFork — Copy resource fork if it exists.
° d ONLN d∏å ~ï Ö (ì ~n
° d ONLN d∫ä êñA )'dataFork — Copy data fork if it exists.
° d ONLN d‚™ ~πz (µ ~'Specifying the Source and Target Folder " ° ∂ ∏ |∏0 ° ∂ ° ∂
° d ONLN d
Ω ~…% *cThe standard ‘infs’ and ‘intf’ file spec resources are used to specify the source and target folder ° d ONLN d n… ~’ * with several differences: ˇ* d ˇ ˇˇˇˇ d
° d ONLN d Q ê ] )WThe path name is similar to normal file specs, but the path should end with the name of ° d ONLN d Z ] ê i» * Ithe source or target folder. A colon at the end of the path is optional.
° d ONLN d § s ~ | Ö ( z ~n
° d ONLN d ¶ q ê }¶ )<All File Spec flags are ignored when used with Folder Atoms.
° d ONLN d „ á ~ ê Ö ( é ~n
° d ONLN d Â Ö ê ë )VThe File Type, File Creator and Creation Date fields are ignored when used with Folder ° d ONLN d< ë ê ù ∞ * Atoms.
° d ONLN dD ß ~ ≤ ö ( Ø ~NOTE
° d ONLN dI µ ~ ¡+ *^The reserved folder path name “special-xxxx” cannot be used with Folder Atoms. If you do, the ° d ONLN d® ¡ ~ Õ^ * 3user will be told the script document is damaged.
° d ONLN d€ √^ Ãe )‡u
° d ONLN d› · ~ ^ ( Ï ~$Installing Folders with Custom Icons " ° ∂ Ô | Ô0 ° ∂ ° ∂
° d ONLN d Ù ~ % *_The Folder Atom will automatically set the target folder to use the source folder’s custom icon ° d ONLN db ~ $ * `if one exits. Although the scriptwriter need not be aware of how the custom icon is stored, the ° d ONLN d√ ~ * _Installer uses the File Atom’s feature of setting the target folder’s icon whenever the special ° d ONLN d# ~$5 * +invisible “Icon\n” file is written to disk.
° d ONLN dO8 ~Gâ *")Creating Empty Folders with a Folder Atom " ° ∂ F |F0 ° ∂ ° ∂
° d ONLN dyK ~W+ *gThe Installer will not create a target folder if there are no files are present in the source file. If ° d ONLN d·W ~c * ^you wish to create an empty folder, the easiest work around is to create a custom icon for the ° d ONLN d@c ~o. * dsource folder, thereby causing the invisible “Icon\n” file to be copied, and the target folder to be ° d ONLN d•o ~{ £ * created.
° d ONLN dÆì 6ß ¯ (¢ 6Folder Atom Reference " ° ∂ ß 4ß0 ° ∂ ° ∂
° d ONLN dƒ¨ ~∏º +HFThe format of the Folder Atom is simple. Its template is shown below. ,
Courier ° d ONLN d » ~‘ ® * #define ° d ONLN d» ¥‘ )6folderAtomFlags ° d ONLN d0»
‘ (—
\ ° d ONLN d4” ¢fl (‹ ¢
fill bit[16]; ° d ONLN dBÈ ~ı Ã (Ú ~
type 'infm' { ° d ONLN dRÙ ¢ “ +$ switch { ° d ONLN d^ˇ ¥ +
case format0: ° d ONLN dp
Δ& + key integer = 0; ° d ONLN dÉ
V )ê /* Folder Atom Format version */ ° d ONLN d® Δ!& ( ΔfolderAtomFlags; ° d ONLN dªV!‡ )ê/* Folder Atom Flags */ ° d ONLN d◊ Δ,, () Δunsigned longInt; ° d ONLN dÎ V,‡ )ê/* Total Folder Size */ ° d ONLN d+ Δ7 (4 ΔrsrcID; ° d ONLN d+V7 )ê /* Target File Spec. Rsrc ID */ ° d ONLN d86 ΔB (? ΔrsrcID; ° d ONLN dE6VB )ê /* Source File Spec. Rsrc ID */ ° d ONLN diA ΔM, (J ΔevenPaddedString; ° d ONLN d}AVMÊ )ê/* Status Description */ ° d ONLN dòL ¢X Æ (U ¢}; ° d ONLN dõW ~c ä (` ~};
° d ONLN dûs ~~ ÿ *Field Descriptions
° d ONLN d≤Å ~ç ‰ *Folder Atom Flags ° d ONLN d√Å ‰ç Ê )f ° d ONLN d≈Åç )*=Currently reserved for use by Apple Computer, Inc. (2-bytes) ° d ONLN dï ~° Í (û ~Total Folder Size ° d ONLN dï° )êBThe size of all files in the source folder. This field is used by ° d ONLN dY°≠ * >the Installer to figure the amount of disk space required. (4 ° d ONLN dó°≠ (™- ° d ONLN dò≠π* (∂bytes) ˇ∂ d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ] ( Z ~Target File Spec. Rsrc ID ° d ONLN d \ h +ê >The resource ID of a Target File Spec (‘intf’) script resource ° d ONLN d Z h t" * @describing the desired location of the target folder. (2-bytes) ° d ONLN d õ | ~ à ( Ö ~Source File Spec. Rsrc ID ° d ONLN d ∂ á ì +ê >The resource ID of a Source File Spec (‘infs’) script resource ° d ONLN d ı ì ü˝ * 8describing the location of the source folder. (2-bytes) ° d ONLN d. ß ~ ≥ Í ( ∞ ~Status Description ° d ONLN dA ß ≥- )ê@An optional string that is displayed in the Status dialog during ° d ONLN dÇ ≥ ø * 9execution of the Folder Atom. (even-padded Pascal string)
° d ONLN dΩ ◊ 6 Î ( Ê 6Using Action Atoms (‘inaa’) " ° ∂ Î 4 Î0 ° ∂ ° ∂
° d ONLN dŸ ~ ¸ +H^Action Atoms are used to run a code resource at the beginning and/or end of an installation or ° d ONLN d8 ¸ ~ ß * removal. ° d ONLN dA ~ Û *To use an Action Atom, an ° d ONLN d[ Û )u'inaa' ° d ONLN da - )$A resource must first be added to the script. This atom specifies ° d ONLN d£ ~(+ (% ~_the resource which contains an executable piece of code. The user-defined Action Atom code can ° d ONLN d( ~4 * bbe executed at two different times for installations. One is after the user clicks on the Install ° d ONLN df4 ~@% * cbutton but before installation begins. The other is after the installation is finished, but before ° d ONLN d @ ~L * `the user is asked to quit or continue. The code can also be executed at two different times for ° d ONLN d+L ~X * \removals. One is after the user clicks on the Remove button but before removal begins. The ° d ONLN dàX ~d * `other is after the removal is finished, but before the user is asked to quit or continue. A new ° d ONLN dÈd ~p * Yoption allows the Busy Cursor animation to be continued/suspended during execution of the ° d ONLN dCp ~| * ^action atom code resource. This option is useful when the code resource displays a dialog and ° d ONLN d¢| ~à * [the Busy Cursor is not appropriate. For installation and removal the order of execution is ° d ONLN d˛à ~î Ì * defined by the ID of the ° d ONLN dà Ìî )o'inaa' ° d ONLN d àî> )$ resources.
° d ONLN d)¨ 6¿ ¯ (ª 6Action Atom Reference " ° ∂ ¿ 4¿0 ° ∂ ° ∂
° d ONLN d?≈ ~—" +H_This section describes the Action Atom resource format, data structures and function interface.
° d ONLN d¥ˆ ~å +H-The format of the Action Atom is shown below. ° d ONLN d‚ ~ ® *#define ° d ONLN dÍ ¥8 )6actionAtomFlagsFormat2 ° d ONLN d
(
\ ° d ONLN d ¢# ˆ ( ¢fill bit[12]; ° d ONLN d-
# (
\ ° d ONLN d1" ¢. Ã (+ ¢boolean ° d ONLN d:" Í.b )HcontinueBusyCursors, ° d ONLN dO"h.‘ )~suspendBusyCursors ° d ONLN dd"
. )¢\ ° d ONLN dh- ¢9 Ã (6 ¢boolean ° d ONLN dq- Í9b )HactAfter, actBefore; ° d ONLN dè-
9 (6
\ ° d ONLN dì8 ¢D Ã (A ¢boolean ° d ONLN dú8 ÍDò )H dontActOnRemove, actOnRemove; ° d ONLN d¿8
D (A
\ ° d ONLN dƒC ¢O à (L ¢boolean ° d ONLN dÕC ÍO§ )H dontActOnInstall, actOnInstall; ° d ONLN dÌY ~e à (b ~
type 'inaa' { ° d ONLN d˝d ¢p “ +$ switch { ° d ONLN d o ¥{ +
case format2: ° d ONLN dz ΔÜ& + key integer = 2; ° d ONLN d.zVÜ )ê!/* Action Atom Format version. */ ° d ONLN dTÖ ΔëP (é ΔactionAtomFlagsFormat2; ° d ONLN dlÖVë‡ )ê/* Action Atom Flags */ ° d ONLN dàê Δú& (ô Δliteral longint; ° d ONLN dõêVúÊ )ê/* Code Resource Type */ ° d ONLN d∏õ Δß ˆ (§ Δinteger; ° d ONLN dΔõVß⁄ )ê/* Code Resource ID */ ° d ONLN d·¶ Δ≤ ˆ (Ø Δlongint; ° d ONLN dÔ¶V≤û )ê /* RefCon */ ° d ONLN d ± ΔΩ ˆ (∫ Δlongint; ° d ONLN d ±VΩ )ê!/* Requested Memory (in bytes) */ ° d ONLN d 4º Δ», (≈ ΔevenPaddedString; ° d ONLN d HºV»Ê )ê/* Status Description */ ° d ONLN d c« ¢” Æ (– ¢}; ° d ONLN d f“ ~fi ä (€ ~}; ˇ6 d ˇ ˇˇˇˇ d
d , Palatino
. +~*C H A P T E R 3 , Helvetica
*Packages and Atoms (Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ú58 ° d ONLN d b ~ m ’ ( j ~Flag Descriptions ,
Courier
° d ONLN d p ~ |b *&continueBusyCursors/suspendBusyCursors ° d ONLN d : { á +ê ;Controls whether the counting fingers busy cursor should be ° d ONLN d v á ì" * =stopped and an arrow cursor shown prior to calling the Action ° d ONLN d ¥ ì üè * Atom code resource. Use the ° d ONLN d — ìè ü˚ )ÅsuspendBusyCursors ° d ONLN d „ ì˚ ü+ )l
flag when ° d ONLN d Ó ü ´ ( ®9you want to display a dialog from within your Action Atom ° d ONLN d( ´ ∑K * code resource. ° d ONLN d7 ø ~ À ( » ~actAfter/ActBefore ° d ONLN dK ø À! )ê;Determines whether this Action Atom code resource is called ° d ONLN dá À ◊« * )before or after the installation/removal. ° d ONLN d± fl ~ Î ( Ë ~dontActOnRemove/actOnRemove ° d ONLN dŒ Í ˆ$ +ê =Determines if this Action Atom code resource should be called ° d ONLN d ˆK *
on a removal. ° d ONLN d
~, ( ~ dontActOnInstall/actOnInstall ° d ONLN d9!$ +ê =Determines if this Action Atom code resource should be called ° d ONLN dw!-a * on an installation.
° d ONLN d∂Å ~ç… +HIThe entry point of the Action Atom code resource must have the interface: ° d ONLN d ë ~ù fi *ActionAtomResult ° d ONLN dë ÍùŒ )l&ActionAtomFormat2( ActionAtom2PBPtr ); ° d ONLN d8´ ~∑* (¥ ~`The Action Atom should return a result telling the Installer what to do after executing the code ° d ONLN dô∑ ~√ñ * Bresource. You can use these constants to specify the result code: ° d ONLN d‹“ ~fi Æ *enum { ° d ONLN d“ ¥fiz )6!kActionAtomResultFatalError = -1, ˇË d ˇ ˇˇˇˇ d
° d ONLN d Q ¥ ]h ( Z ¥ kActionAtomResultContinue = 0, ° d ONLN d " \ ¥ hh * kActionAtomResultCancel = 1 }; ° d ONLN d A r ~ ~2 ( { ~ typedef long ActionAtomResult; ° d ONLN d ` ï ~ °@ *#,Return results produce the following effect: ,
° d ONLN d ‹ Ω ê … ∞ )Return ° d ONLN d „ Ω ∞ …: ) kActionAtomResultCancel ° d ONLN d ˙ Ω: … )ä4 to cancel the installation, just as if the user had ° d ONLN d/ … ê ’, ( “ ê[pressed the Cancel button. When an action atom returns the cancel message, all action atom ° d ONLN dã ’ ê ·* * _waiting in the queue are not run. Cancel messages are then sent to all ‘after’ action atoms to ° d ONLN dÎ · ê ÌN * )allow them to clean up their environment.
° d ONLN d ˜ ~ Ö ( ˛ ~n
° d ONLN d ı ê ∞ )Return ° d ONLN d ı ∞R ) kActionAtomResultFatalError ° d ONLN d9 ıR )¢, to signal that there is something seriously ° d ONLN df ê
(
êWwrong, and the installation should not continue. When an action atom returns the error ° d ONLN dæ
ê* * ]message, all action atoms waiting in the queue are not run. Cancel messages are then sent to ° d ONLN d ê%√ * Eall ‘after’ action atoms to allow them to clean up their environment.
° d ONLN db/ l9 u (7 ls
° d ONLN dd/ ~: ¡ )
W A R N I N G
° d ONLN dr= ~I *\If you choose to create a sub-heap for each invocation of format 2 of the Action Atom please ° d ONLN dœI ~U * Sread the section “Running with a Sub-Heap” within the Atom Extender portion of this ° d ONLN d#U ~a' * `document. You can enter 0 (zero) in the requested memory field to not create a sub-heap and run ° d ONLN dÑa ~m * inside the Installer’s heap.
° d ONLN d£c l )Çs
° d ONLN d•Å 6è ë (ã 6Parameter Block " ° ∂ è 4è0 ° ∂ ° ∂
fMessageID ° d ONLN døiu )ê9One of three messages the Atom Extender will receive when ° d ONLN d˘uÅ* * ?being called. Use these constants to understand the message ID: ° d ONLN d:âï\ *
enum {before, ° d ONLN dJî2†V +$ after, ° d ONLN dSü2´í * cleanUpCancel }; ° d ONLN de≤æ˛ (ª(typedef unsigned char InstallationStage; ° d ONLN dè≈— *<If your Action Atom is running before the installation takes ° d ONLN d×›> * place, the ° d ONLN d◊—>›z )0
fMessageID ° d ONLN d·—z›ü )<
field is ° d ONLN dΗü›√ )%before ° d ONLN dÒ—√›Δ )$. ˇû d ˇ ˇˇˇˇ d
° d ONLN d Q ]' ( Z?If your Action Atom is running after the installation completes ° d ONLN d @ ] iZ * successfully, the ,
Courier ° d ONLN d R ]Z iñ )L
fMessageID ° d ONLN d \ ]ñ i” )< field will be ° d ONLN d k ]” iÒ )=after ° d ONLN d p ]Ò iÙ ) . ° d ONLN d s q }
( z;If the user clicks the Cancel/Stop button, or the Installer ° d ONLN d Ø } â“ * .cancels the installation because of an error, ° d ONLN d › }“ â )ƒ
cleanUpCancel ° d ONLN d Î â ï ( í>messages are sent to all ‘after’ action atoms to allow them to ° d ONLN d* ï ° * 8clean up their environment. Each ‘after’ action atom is ° d ONLN dc ° ≠˜ * 4guaranteed to receive only one cancel message if the ° d ONLN dò ≠ π * <installation is canceled or stopped. This may happen before ° d ONLN d’ π ≈- * Bthe ‘before’ actions atoms have run, so it’s important to be smart ° d ONLN d ≈ —í * within your cleanup routines. ° d ONLN d6 Ÿ ~  “ ( ‚ ~fStaticDataHdl ° d ONLN dE Ÿ  )ê7A handle created by the Action Atom using INewHandle to ° d ONLN d}  Ò$ * >save information between before and after calls to this Action ° d ONLN dº Ò ˝˜ * 1Atom. The field is always NULL when receiving a ° d ONLN dÌ Ò˜ ˝ )Èbefore ° d ONLN dÙ ˝ (?message. You can assign a value to this field during the first ° d ONLN d4 * ;call to the Action Atom, and receive the same value in this ° d ONLN dp!Ç * field during the next call. ° d ONLN då) ~5 fi (2 ~fCallBackProcPtr ° d ONLN dù)5 )ê>A pointer to the Installer’s dispatch routine. You’ll need to ° d ONLN d‹5A * <pass this field as a parameter to glue routines that provide ° d ONLN dAMã * access to Installer functions. ° d ONLN d8U ~a “ (^ ~fTargetVRefNum ° d ONLN dGUa, )ê>The target disk’s vRefNum. When allowing the user to select a ° d ONLN dÜam * :target application folder, this is the volume on which the ° d ONLN d¡myO * folder resides. ° d ONLN d—Å ~ç Í (ä ~fTargetFolderDirID ° d ONLN d‰Åç* )ê@The target application folder’s directory ID. Target File Specs ° d ONLN d%çôß * "that use the reserved folder path ° d ONLN dGçßôÈ )ô folder-user ° d ONLN dRçÈô, )B will be placed ° d ONLN dbô• (¢@in this folder. This value is -1 if the Installer is using disk ° d ONLN d£•± * ?mode, the folder does not exist, or a File Spec referencing the ° d ONLN d„±Ωn * reserved folder path ° d ONLN d¯±nΩ∞ )` folder-user ° d ONLN d±∞Ω' )B has not been referenced by ° d ONLN d Ω…∫ (Δ&any atom included in the installation. ° d ONLN dH— ~› “ (⁄ ~fSystemVRefNum ° d ONLN dW—› )ê:The system disk’s vRefNum. Target File Specs that use the ° d ONLN dí›Èn * reserved folder path ° d ONLN dß›nÈ∞ )` special-xxx ° d ONLN d≤›∞È )B will be placed in the ° d ONLN d…Èıñ (Ú System Folder on this volume. ° d ONLN dÁ˝ ~ Í ( ~fSystemFolderDirID ° d ONLN d˙˝ )ê:The directory ID of the System Folder on the disk with the ° d ONLN d5 3 * refNum ° d ONLN d< 3á )%fSystemVRefNum ° d ONLN dJ á )T$. This directory is not necessarily ° d ONLN do!Æ ( #the currently active System Folder. ° d ONLN dì) ~5 ® (2 ~fRefCon ° d ONLN dõ)5" )ê?A 4-byte value defined by the scriptwriter in the ‘inex’ script ° d ONLN d€5A5 * resource. ° d ONLN dÂI ~U à (R ~
fDoingInstall ° d ONLN dÛIU )ê:TRUE if the user is performing an installation; otherwise, ° d ONLN d.Uaó * FALSE if the user is removing. ° d ONLN dMi ~u “ (r ~fDidLiveUpdate ° d ONLN d\iu )ê:TRUE if the Installer is modifying files inside the active ° d ONLN dóuÅR * System Folder. ° d ONLN d¶â ~ï (í ~fInstallerTempDirID ° d ONLN d∫âï )ê6The directory ID of the temporary folder on the volume ° d ONLN dÒï°W * specified in the ° d ONLN d ïW°´ )IfSystemVRefNum ° d ONLN d ï´°- )T field. The temporary folder ° d ONLN d .°≠) (™?holds the files that we are modifying to allow rollback in case ° d ONLN d n≠π * >the installation is canceled. You’ll rarely ever need to look ° d ONLN d ≠π≈` * inside this folder. ˇ d ˇ ˇˇˇˇ d
° d ONLN d j ~ v +HWDuring the development of System Software scripts, there were many times we wished that ° d ONLN d s v ~ Ç * Wthere was a history of what had previously been installed. For example, the user did a ° d ONLN d À Ç ~ é * Uminimal SE System Software installation, and later wanted to add minimal Macintosh II ° d ONLN d! é ~ ö * YSystem Software. During the second installation, the Installer should be smart enough to ° d ONLN d{ ö ~ ¶' * ]update the disk with both SE and II software. Installer Audit Atoms were added to facilitate ° d ONLN dŸ ¶ ~ ≤i * 4this type of updating. Their format is shown below. ° d ONLN d ∫ ~ Δ' *`When the Installer finds an Audit Atom in a script, after an installation is complete, it adds a ° d ONLN do Δ ~ “ ” * new resource (type ,
Courier ° d ONLN dÇ Δ ” “ ˜ )U'audt' ° d ONLN dà Δ ˜ “ )$@) to the target file specified in the Audit Atom. This resource ° d ONLN d… “ ~ fin ( € ~8contains an array of audit selector/value pairs. If an ° d ONLN d “n fií )'audt' ° d ONLN d “í fi )$ resource already exists in the ° d ONLN d' fi ~ Í ( Á ~atarget file and there is no entry for the given selector, an entry is added. If an entry for the ° d ONLN dâ Í ~ ˆ * Yselector already exists, the higher of the two values is used. Using the Installer Rules ° d ONLN d„ ˆ ~ fi * checkAuditRecord ° d ONLN dÛ ˆ fi Û )` and ° d ONLN d¯ ˆ Ûe )checkAnyAuditRecord ° d ONLN d ˆe )r(, later installations can make decisions ° d ONLN d4 ~ ‡ ( ~based on this history.
° d ONLN du` ~l +H Format 0 of the ‘inat’ resource: ° d ONLN dñp ~| Ã *
type 'inat' { ° d ONLN d•{ êá ¿ + switch { ° d ONLN d∞Ü ¢í +
case format0: ° d ONLN d¡ë ¥ù + key integer = 0; ° d ONLN d÷ú Δ® + FileSpecID; ° d ONLN d‰ú2®‡ )l /* Target File Spec Rsrc ID*/ ° d ONLN dß Δ≥ (∞ ΔOSType; ° d ONLN dß2≥™ )l/* Audit Selector */ ° d ONLN d*≤ Δæ& (ª Δliteral longint; ° d ONLN d;≤2æò )l/* Audit Value */ ° d ONLN dPΩ ¥… ¿ (Δ ¥}; ° d ONLN dS» ~‘ ä (— ~};
° d ONLN dV‰ ~Ô ◊ *Field descriptions
° d ONLN diÚ ~˛ *Target File Spec. Rsrc ID ° d ONLN dÇÚ˛ )ñ ° d ONLN dÖ˝ + (?The resource ID of a Target File Spec. of which you want to add ° d ONLN d≈ * <or update the audit resource. Apple uses the System File to ° d ONLN d!% * =keep a history of System Software that has been installed. A ° d ONLN d@!-> * File Spec ( ° d ONLN dK!>-b )0'intf' ° d ONLN dQ!b-" )$- resource) must exist in the script with this ° d ONLN d-9J (6ID. (2-bytes) ° d ONLN déA ~M “ (J ~Audit Selector ° d ONLN dúA “M ‘ )T ° d ONLN dûAMí )< A meaningful type. (4-bytes) ° d ONLN dºU ~a ¿ (^ ~ Audit Value ° d ONLN d«U ¿a ¬ )B ° d ONLN d…Uaó )N A meaningful value. (4-bytes)
° d ONLN dí ~û! +H]Boot Block Atoms are used to write or change the parameters in a target volume’s boot blocks. ° d ONLN dgû ~™* * _Boot Block Atoms are different from file and resource atoms – they can indicate something to be ° d ONLN d«™ ~∂π * Ecopied, or indicate an individual parameter that needs to be changed. ° d ONLN d
æ ~ *^To cause boot blocks to be written to a target volume, include a Boot Block Atom with a key of ° d ONLN dl ~÷ ï * type ° d ONLN dq ï÷ — )
'bbUpdate' ° d ONLN d{ —÷+ )<M. The argument to this type of Boot Block Atom is an integer which indicates ˇ
° d ONLN d Ì ª ~ « +H Format 0 of the ‘inbb’ resource: ° d ONLN d À ~ ◊ ® *#define ° d ONLN d À ¥ ◊ )6BootBlockAtomFlags ° d ONLN d2 À‘ ◊⁄ ( ‘‘\ ° d ONLN d5 ÷ ê ‚ fi ( fl ê
fill bit[14]; ° d ONLN dP ÷‘ ‚⁄ ( fl‘\ ° d ONLN dT · ¢ Ì Ã ( Í ¢boolean ° d ONLN d\ · ÿ Ì∂ )6%dontChangeOnInstall, changeOnInstall; ° d ONLN dÉ ·‘ Ì⁄ )¸\ ° d ONLN dá Ï ¢ ¯ à ( ı ¢boolean ° d ONLN dè Ï ÿ ¯™ )6#dontChangeOnRemove, changeOnRemove; ° d ONLN d≥ ~ ® ( ~#define ° d ONLN dª ¥, )6BootBlockUpdateFlags ° d ONLN dŸ‘⁄ ( ‘\ ° d ONLN d›
¢ Í ( ¢ fill bit[7]; ° d ONLN dˆ
‘⁄ (‘\ ° d ONLN d˙ ¢$ à (! ¢boolean ° d ONLN d ÿ$û )6!replaceBBSysName, saveBBSysName; ° d ONLN d&‘$⁄ )¸\ ° d ONLN d*# ¢/ à (, ¢boolean ° d ONLN d2# ÿ/™ )6#replaceBBShellName, saveBBShellName ° d ONLN dX#‘/⁄ )¸\ ° d ONLN d\. ¢: à (7 ¢boolean ° d ONLN dd. ÿ:§ )6"replaceBBDbg1Name, saveBBDbg1Name; ° d ONLN dâ.‘:⁄ )¸\ ° d ONLN dç9 ¢E à (B ¢boolean ° d ONLN dï9 ÿE™ )6#replaceBBDbg2Name, saveBBDbg2Name; ° d ONLN dª9‘E⁄ )¸\ ° d ONLN døD ¢P à (M ¢boolean ° d ONLN d«D ÿPº )6&replaceBBScreenName, saveBBScreenName; ° d ONLN dÔD‘P⁄ )¸\ ° d ONLN dÛO ¢[ à (X ¢boolean ° d ONLN d˚O ÿ[∂ )6%replaceBBHelloName, saveBBHelloName; ° d ONLN d"O‘[⁄ )¸\ ° d ONLN d&Z ¢f à (c ¢boolean ° d ONLN d.Z ÿf∞ )6$replaceBBScrapName, saveBBScrapName; ° d ONLN dTZ‘f⁄ )¸\ ° d ONLN dXe ¢q à (n ¢boolean ° d ONLN d`e ÿqò )6 replaceBBCntFCBs, maxBBCntFCBs; ° d ONLN dÑe‘q⁄ )¸\ ° d ONLN dàp ¢| à (y ¢boolean ° d ONLN dêp ÿ|å )6 replacebbCntEvts, maxBBCntEvts ° d ONLN d≤p‘|⁄ )¸\ ° d ONLN d¥Ü ~í à (è ~
type 'inbb' { ° d ONLN d√ë êù ¿ + switch { ° d ONLN dŒú ¢® +
case format0: ° d ONLN dflß ¥≥ + key integer = 0; ° d ONLN dÛ≤ ¥æ& * BootBlockAtomFlags; ° d ONLN d Ω Δ… ˆ + switch { ° d ONLN d» ÿ‘, + case bbUpdate: ° d ONLN d.” ÍflP + key integer = -1; ° d ONLN dGfi ÍÍ * RsrcID; ° d ONLN dVÈ Íıh * BootBlockUpdateFlags; ° d ONLN dxˇ ÿ ( ÿ
ÿcase bbHelloName: ° d ONLN dK ÍP + key integer = 10; ° d ONLN dc Í#P * EvenPaddedString; ° d ONLN dÅ- ÿ9> (6 ÿcase bbScrapName: ° d ONLN dô8 ÍDP + key integer = 11; ° d ONLN d±C ÍOP * EvenPaddedString; ° d ONLN dœY ÿe2 (b ÿcase bbCntFCBs: ° d ONLN dÂd ÍpP + key integer = 12; ° d ONLN d˝o Í{J * decimal integer; ° d ONLN dÖ ÿë2 (é ÿcase bbCntEvts: ° d ONLN d0ê ÍúP + key integer = 13; ° d ONLN dHõ ÍßJ * decimal integer; ° d ONLN de± ÿΩ> (∫ ÿcase bb128KSHeap: ° d ONLN d}º Í»P + key integer = 14; ° d ONLN dï« Í”J * decimal longint; ° d ONLN d≤› ÿÈ> (Ê ÿcase bb256KSHeap: ° d ONLN d Ë ÍÙP + key integer = 15; ° d ONLN d‚Û ÍˇJ * decimal longint; ° d ONLN dˇ ÿ> ( ÿcase bb512KSHeap: ° d ONLN d Í P + key integer = 16; ° d ONLN d/ Í+J * decimal longint; ° d ONLN dL5 ÿAJ (> ÿcase bbSysHeapSize: ° d ONLN df@ ÍLP + key integer = 16; ° d ONLN d~K ÍWJ * decimal longint; ° d ONLN dõa ÿmP (j ÿcase bbSysHeapExtra: ° d ONLN d∂l ÍxP + key integer = 18; ° d ONLN dŒw ÍÉJ * decimal longint; ° d ONLN dÎç ÿôP (ñ ÿcase bbSysHeapFract: ° d ONLN dò ͧP + key integer = 19; ° d ONLN d £ ÍØJ * decimal longint; ° d ONLN d3Æ Δ∫ “ (∑ Δ}; ° d ONLN d:π Δ≈, * EvenPaddedString; ° d ONLN dNπV≈ )ê!/* Boot Block Atom Description */ ° d ONLN drƒ ¢– Æ (Õ ¢}; ° d ONLN duœ ~€ ä (ÿ ~}; ˇ≤ d ˇ ˇˇˇˇ d
d , Palatino
. +~*C H A P T E R 3 , Helvetica
*Packages and Atoms (Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ú64 ° d ONLN d b ~ m ⁄ ( j ~Flags descriptions ,
Courier
° d ONLN d p ~ |P *#dontChangeOnInstall/changeOnInstall ° d ONLN d 6 pP |R )“ ° d ONLN d 9 { á ( Ñ8Determine if the boot blocks should be updated during an ° d ONLN d r á ìu * installation. (2-bytes) ° d ONLN d ã õ ~ ßD ( § ~!dontChangeOnRemove/changeOnRemove ° d ONLN d ¨ õD ßF )Δ ° d ONLN d Ø ¶ ≤™ ( Ø#Not currently supported. (2-bytes)
° d ONLN d ” º ~ « ◊ ( ƒ ~Field descriptions
° d ONLN d Ê ~ ÷ ˆ *Boot Block Value Key ° d ONLN d ˙ ˆ ÷ ¯ )x ° d ONLN d ¸ ÷' )>Specifies which boot block parameter is being given a value in ° d ONLN d; ÷ ‚ * =the Boot Block Value field. The key can correspond to any of ° d ONLN dy ‚ Ó * ;the parameters which are changeable in the boot blocks. (2 ° d ONLN d¥ ‚ Ó ( Î- ° d ONLN dµ Ó ˙* ( ˜bytes) ° d ONLN dΩfl *0The possible keys for this field are as follows: ° d ONLN dÓ ~" Æ ( ~bbUpdate ° d ONLN d˜"ê )ê Copy over boot blocks from a ° d ONLN dê"¥ )Ç'boot' ° d ONLN d¥"% )$ resource found in the file ° d ONLN d6".) (+@whose File Spec ID is given in the 2-byte value field. A second ° d ONLN dw.: * =2-byte value field is used for this type of Boot Block Value. ° d ONLN d∂:F * ;This second value field is used to specify which boot block ° d ONLN dÚFR§ * "fields are to be updated from the ° d ONLN dF§R» )ñ'boot' ° d ONLN dF»R$ )$ resource, and which ° d ONLN d/R^! ([Aones are to be preserved on the target disk. If bits 0 through 6 ° d ONLN dq^j * :are set, the appropriate value on the target is kept if it ° d ONLN d¨jv * Cappears to be a legal value or string. If bits 7 or 8 are set, the ° d ONLN dvÇ$ * :maximum parameter from the resource or what already exists ° d ONLN d+Çé
* ;on the target is preserved. The format of this field is as ° d ONLN dgéö3 * follows: ° d ONLN dp¢ ~Æ ñ (´ ~bbID ° d ONLN du¢Æ )ê8The Boot Block Value field updates the boot blocks ID (2 ° d ONLN d≠¢Æ (´- ° d ONLN dÆÆ∫- (∑bytes). ° d ONLN d∂¬ ~Œ ® (À ~bbEntry ° d ONLN d欌 )ê7The value updates the boot block entry point (4-bytes). ° d ONLN dˆ÷ ~‚ ¥ (fl ~ bbVersion ° d ONLN d ÷‚Ù )ê3The value updates the boot block version (2-bytes). ° d ONLN d4Í ~ˆ ¿ (Û ~ bbPageFlags ° d ONLN d@͈ı )ê3The value updates the page 2 usage flags (2-bytes). ° d ONLN dt˛ ~
¥ ( ~ bbSysName ° d ONLN d~˛
, )ê@The value updates the name of the system resource file (string). ° d ONLN dø ~ ¿ ( ~ bbShellName ° d ONLN dÀ
)ê8The value updates the name of the system shell (string). ° d ONLN d& ~2 ∫ (/ ~
bbDbg1Name ° d ONLN d&2 )ê<The value updates the first loaded debugger’s name (string). ° d ONLN dL: ~F ∫ (C ~
bbDbg2Name ° d ONLN dW:F' )ê=The value updates the second loaded debugger’s name (string). ° d ONLN dïN ~Z Δ (W ~ bbScreenName ° d ONLN d¢NZ% )ê?The value updates the file name of the startup screen (string). ° d ONLN d‚b ~n ¿ (k ~ bbHelloName ° d ONLN dÓbn )ê6The value updates the file name of the startup program ° d ONLN d%nz3 * (string). ° d ONLN d/Ç ~é ¿ (ã ~ bbScrapName ° d ONLN d;Çé )ê8The value updates the file name of the system scrap file ° d ONLN dtéö3 * (string). ° d ONLN d~¢ ~Æ ¥ (´ ~ bbCntFCBs ° d ONLN dà¢Æ )ê7The value updates the number of FCBs to open (2-bytes). ° d ONLN d¿∂ ~¬ ¥ (ø ~ bbCntEvts ° d ONLN d ∂¬ )ê8The value updates the size of the event queue (2-bytes). ° d ONLN d ~÷ ¿ (” ~ bb128KSHeap ° d ONLN d ÷∏ )ê(This boot block field is no longer used. ˇ d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ] ¿ ( Z ~ bb256KSHeap ° d ONLN d Q ]∏ )ê(This boot block field is no longer used. ° d ONLN d 5 e ~ q ¿ ( n ~ bb512KSHeap ° d ONLN d A e q" )ê;The value updates the size of the system heap on a 512K Mac ° d ONLN d } q }: *
* ;the boot block value key. It has a size as given above (in ° d ONLN dö )Û * 3parentheses). (size depends on the type of update)
° d ONLN dŒA 6U/ (P 6 About Atom Extenders (‘inex’) " ° ∂ U 4U0 ° ∂ ° ∂
° d ONLN dÏZ ~f% +H\Scriptwriters can use Atom Extenders to enhance or replace the default copy mechanism of the ° d ONLN dIf ~rÛ * SInstaller. The most obvious purpose of the Atom Extender is to provide transparent ° d ONLN dùr ~~
* Zdecompression of files during installation. Scriptwriters presently using Action Atoms to ° d ONLN d¯~ ~ä' * \perform decompression, either written by themselves or a third-party developer, will want to ° d ONLN dUä ~ñ[ * 2use Atom Extenders for this purpose in the future. ° d ONLN dàû ~™) *]If you want to write an Atom Extender then read the section “Writing Atom Extenders” to learn ° d ONLN dÊ™ ~∂ * Zhow. If you only want to take advantage of an Atom Extender someone else has written then ° d ONLN dA∂ ~¬‘ * Kconsult the sections describing the File Atom, Resource Atom and Font Atom.
° d ONLN dç⁄ 6Ó (È 6Writing Atom Extenders " ° ∂ Ó 4Ó0 ° ∂ ° ∂
° d ONLN d§Û ~ˇ" +H^An Atom Extender is a newly-defined script resource of type ‘inex’ that can be referenced from ° d ONLN dˇ ~ * Wnew versions of the File Atom, Resource Atom, and Font Atoms. At the heart of the Atom ° d ONLN d[ ~' * _Extender is a code resource (provided by the scriptwriter) that contains the necessary 68K code ° d ONLN dª ~#q * 8to be executed at the desired point in the installation. ° d ONLN dı+ ~7µ *FThis section describes the necessary steps to create an Atom Extender.
° d ONLN d<K ~ZQ *""Creating an ‘inex’ Script Resource " ° ∂ Y |Y0 ° ∂ ° ∂
° d ONLN d_^ ~j& *`The new ‘inex’ script resource contains the necessary information to properly call the specified ° d ONLN d¿j ~v ª * code resource.
° d ONLN d—~ ~â œ *Code Listing 3-1 ° d ONLN d‚~ Íâ^ )l Sample ‘inex’ script resource
° d ONLN d à ~î (ë ~resource 'inex' (129) { ° d ONLN dì êü Δ + format0 { ° d ONLN d%û ¢™ + dontSendInitMessage, ° d ONLN d;û2™
)ê$/* Resource type of code resource */ ° d ONLN d 4 \ ¢ h ∫ ( e ¢128, ° d ONLN d ? \2 h˛ )ê"/* Resource ID of code resource */ ° d ONLN d d g ¢ s ∫ ( p ¢100, ° d ONLN d o g2 s‘ )ê/* RefCon (long integer) */ ° d ONLN d ç r ¢ ~ Δ ( { ¢30720, ° d ONLN d ô r2 ~. )ê*/* 30K of requested free memory in heap */ ° d ONLN d Δ } ¢ â ( Ü ¢"This is a test." ° d ONLN d ⁄ }2 â
)ê$/* Status description during call */ ° d ONLN d à ê î ñ ( ë ê} ° d ONLN d ì ~ ü ä ( ú ~}; ° d ONLN d ¢ ~ Ær *7The sample ‘inex’ resource in Code Listing 3-1 asks the
° d ONLN d< £r Æu )Ù
° d ONLN d= ¢u Æ# )(Installer to call the code resource with ° d ONLN df Æ ~ ∫) ( ∑ ~_the type ‘infn’ and ID = 128 before the Installer begins copying the atom’s data from which the ° d ONLN dΔ ∫ ~ Δ, * ^Atom Extender is referenced. When the code resource is called it will have a maximum of 30720 ° d ONLN d% Δ ~ “ * Tbytes of free memory in its own heap, from which it can allocate memory using Memory ° d ONLN dz “ ~ fi Û * Manager routines, such as ° d ONLN dî “ Û fi )uNewPtr ° d ONLN dö “ fi, )$ and ° d ONLN dü “, fib ) NewHandle ° d ONLN d® “b fi) )6-. You must check the actual size of the heap ° d ONLN d÷ fi ~ Í+ ( Á ~aat the beginning of your code resource to make sure you were allocated the full amount, since the ° d ONLN d8 Í ~ ˆ$ * `Installer calls you whether or not your requested was fully granted. This error will usually be ° d ONLN dô ˆ ~
* [an idication that the Installer’s memory partition is set too low. The actual heap size is ° d ONLN dı ~ * Zusually 5K larger than the requested size, but you should never depend on this being true.
° d ONLN dP ~# ö *NOTE
° d ONLN dU& ~2’ *LAtom Extenders are only called during installations, never during removals. ,
Zapf Dingbats
° d ONLN d°(’1‹ (/’u
° d ONLN d£F ~UC (Q ~ Writing a Simple Atom Extender " ° ∂ T |T0 ° ∂ ° ∂
° d ONLN d¬Y ~e *]A very simple task for an Atom Extender is to simulate the default copy task of the Installer ° d ONLN d e ~q * ]using the supplied Installer routines. In Code Listing 3-2 the function reads and writes the ° d ONLN d~q ~}1 * )atom’s data using the Installer routines ° d ONLN dßq1}Ö )≥ReadSourceData ° d ONLN dµqÖ}ö )T and ° d ONLN d∫qö}Ù )WriteTargetData ° d ONLN d…qÙ}˜ )Z.
° d ONLN dÀÖ ~ê œ (ç ~Code Listing 3-2 ° d ONLN d‹Ö Íê )l@Simple Atom Extender performing a direct copy of an atom’s data.
° d ONLN d è 6õ (ò 6&ExtenderResultCode main( ExtenderPBPtr ° d ONLN dEè2õå )¸extenderPBPtr ) ° d ONLN dUö 6¶ < (£ 6{ ° d ONLN dX• H± f + OSErr ° d ONLN dc• Δ± )~theErr; ° d ONLN dl∞ Hº ` (π Hlong ° d ONLN dv∞ Δº ˆ )~dataLen; ° d ONLN dĪ H« Z (ƒ HPtr ° d ONLN dâª Δ« )~
theBufferPtr; ° d ONLN dòΔ H“ ¥ (œ HExtenderResultCode ° d ONLN d´Δ Δ“ )~ resultCode; ° d ONLN d∏‹ HË8 ( H(// -- Initalize some important variables ° d ONLN d‚Á HÛ ® * dataLen = 30000; ° d ONLN dÙÚ H˛ ¢ * theErr = noErr; ° d ONLN d Hí *7// -- Depending on the message, perform the proper task ° d ONLN d> H Ú * Gswitch( extenderPBPtr->fFileCopyPBRec.fEnvironmentHeader.fMessageID ) { ° d ONLN dà) Z5 ¿ +case kBeforePart: ° d ONLN d†? lK Í +// -- Create a buffer ° d ONLN dπJ lV& * theBufferPtr = NewPtr(dataLen); ° d ONLN dfl` llÜ */// -- Check that we got our buffer successfully ° d ONLN dk lwí * 1if( theBufferPtr != NULL && MemErr() == noErr ) { ° d ONLN dKÅ ~ç⁄ +:// -- Read as much as we can up to the size of the buffer. ° d ONLN däå ~ò§ * 1theErr = ReadSourceData( &dataLen, theBufferPtr); ° d ONLN d¿¢ ~ÆÜ *,// -- Loop while there is more data to read. ° d ONLN dÚ≠ ~π * while( dataLen > 0 ) { ° d ONLN d Œ ê⁄ +!B// -- This is where we can massage the data before writing it out. ˇ. d ˇ ˇˇˇˇ d
case kCancel: ° d ONLN dÅË lÙ& + resultCode = kContinueAsNormal; ° d ONLN d§Û lˇ ê * break; ° d ONLN d¨˛ H
N ( H} ° d ONLN d± H ¥ *return resultCode; ° d ONLN dƒ 6+ < (( 6} ° d ONLN dΔ. ~: +H_Once the code in Code Listing 3-2 has been compiled into a code resource, it can be called from ° d ONLN d&: ~F$ * ]any atom and will copy the atom’s data as if the Installer had performed the copy. This also ° d ONLN dÑF ~R * ]works for atoms whose source pieces have been split across multiple source disks, because the ° d ONLN d‚R ~^
* [Installer keeps track of where each source piece should be written in the target file. The ° d ONLN d>^ ~j¡ * HInstaller data routines are similar to high-level File Manager routines: ,
Zapf Dingbats
° d ONLN dát ~} Ö *n
° d ONLN dâr ê~ ‰ )ReadSourceData ° d ONLN dór ‰~# )T — Similar to ° d ONLN d•r#~G )?FSRead ° d ONLN d´rG~J )$.
° d ONLN d≠à ~ë Ö (è ~n
° d ONLN dØÜ êí Í )WriteTargetData ° d ONLN dæÜ Íí) )Z — Similar to ° d ONLN dÃÜ)íS )?FSWrite ° d ONLN d”ÜSíV )*.
° d ONLN d’ú ~• Ö (£ ~n
° d ONLN d◊ö ê¶ )SetTargetDataPos ° d ONLN dÁö ¶ )` and ° d ONLN dÏö¶e )SetSourceDataPos ° d ONLN d¸öe¶§ )` — Similar to ° d ONLN d
ö§¶‘ )?SetFPos.
° d ONLN d∞ ~π Ö (∑ ~n
° d ONLN dÆ ê∫ )GetTargetDataPos ° d ONLN d%Æ ∫ )` and ° d ONLN d*Æ∫e )GetSourceDataPos ° d ONLN d:Æe∫§ )` — Similar to ° d ONLN dHƧ∫Œ )?GetFPos ° d ONLN dOÆŒ∫— )*.
° d ONLN dQƒ ~Õ Ö (À ~n
° d ONLN dS¬ êŒ )GetTargetDataEOF ° d ONLN dc¬ Œ )` and ° d ONLN dh¬Œe )GetSourceDataEOF ° d ONLN dx¬eŒ§ )` — Similar to ° d ONLN dܬ§ŒŒ )?GetEOF. ˇ` d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ] ( Z ~\One of five messages can be sent to the Atom Extender. Flags in the ‘inex’ resource specify ° d ONLN d ] ] ~ i$ * Ywhich messages the Atom Extender wishes to receive. The Atom Extender writer can examine ° d ONLN d ∑ i ~ u ê * the ,
Courier ° d ONLN d ª i ê u à )
fMessageID ° d ONLN d ≈ i à u& )<L field in the parameter block to determine which message has been sent. The ° d ONLN d u ~ Å- ( ~ ~%following messages have been defined: ,
Zapf Dingbats
° d ONLN d8 ã ~ î Ö *n
° d ONLN d: â ê ï “ ) kInitialize ° d ONLN dE â “ ï )BE — Sent after the user clicks the Install button and preflighting has ° d ONLN dã ï ê ° ˘ ( û êsuccessfully completed.
kCancelInstallation ° d ONLN dÑ5A" )r to ° d ONLN dàA ~M: (J ~+stop the installation. If the message was ° d ONLN d≥A:M| )º kBeforePart ° d ONLN dæA|M )B$ and you’ve copied the data yourself ° d ONLN d„M ~Yë (V ~>(with or without the supplied Installer routines) then return ° d ONLN d!MëY” (Vë kCopiedData ° d ONLN d,M”Y÷ )B.
° d ONLN d.m ~|Ä (x ~'Memory Allocation within Atom Extenders " ° ∂ { |{0 ° ∂ ° ∂
° d ONLN dVÄ ~å$ *XWhen the Atom Extender is executed, memory allocated using Macintosh OS/Toolbox routines ° d ONLN dØå ~ò% * ^will come from a sub-heap created by the Installer. The size of the sub-heap is determined by ° d ONLN dò ~§* * athe requested free memory field of the ‘inex’ resource, and the available room in the Installer’s ° d ONLN dp§ ~∞ * \heap. You must check the actual size of the heap to make sure you were allocated all of the ° d ONLN dÕ∞ ~º * Wmemory you requested, since the Installer calls you whether or not all your request was ° d ONLN d%º ~» * Xallocated. This helps the Installer maintain better control over all memory allocation. ° d ONLN d~– ~‹ *]The scriptwriter may need to adjust the size of the Installer’s partition to make sure enough ° d ONLN d‹‹ ~Ë * Wmemory is always available for the Atom Extender’s needs. The following equation helps ° d ONLN d4Ë ~Ù * Xdetermine the Installer’s partition size for the required free memory and other factors. ° d ONLN dé¸ ê +VrunTimeSize = size of the largest: ‘FOND’ resource, Desk Accessory resource, or owned ° d ONLN d ê Ò * resource being copied. ° d ONLN d˛ ê(" *XextenderSize = largest required free memory of any Atom Extender + code size of all Atom ° d ONLN d W( ê4 * XExtenders, in use during an installation + the total amount of static memory allocated. ° d ONLN d ±< êHd *0scriptSize = the uncompressed size of the script ° d ONLN d „P ê\ *Yestimated partition size = (the larger of: runTimeSize, extenderSize) + scriptSize + 350K ° d ONLN d
=d ~p (m ~[Installer 4.0 provides memory management routines of its own to allow Atom Extenders to use ° d ONLN d
ôp ~|$ * [available memory from the MultiFinder and Installer heaps. These routines are very similar ° d ONLN d
ı| ~ภ* Rto the Memory Manager calls, but are needed to maintain compatibility with pre-7.0 ° d ONLN d Hà ~î) * #MultiFinder temporary memory calls.
° d ONLN d lû ~ß Ö *n
° d ONLN d nú ê® Ã )
INewHandle ° d ONLN d xú î )< — Similar to ° d ONLN d Üú ®A )? NewHandle ° d ONLN d èúA®ä )6, but always use ° d ONLN d †úä®ÿ )I
IDisposHandle ° d ONLN d ≠úÿ® )N to dispose this ° d ONLN d æ® ê¥ … (± ê handle, and ° d ONLN d ® …¥ Ì )9IHLock ° d ONLN d –® Ì¥ )$ and ° d ONLN d ‘® ¥6 ) IHUnlock ° d ONLN d ›®6¥ )63 to lock and unlock this handle. The handle may or ° d ONLN d ¥ ê¿Ü (Ω ê4may not have been allocated in the MultiFinder heap.
° d ONLN d F ~” Ö (— ~n
° d ONLN d H» ê‘ ‰ )IDisposHandle ° d ONLN d V» ‰‘! )T
— Similar to ° d ONLN d c»!‘i )= DisposHandle ° d ONLN d o»i‘l )H. ˇ^ d ˇ ˇˇˇˇ d
° d ONLN d\ Ω ~ Ã( *"Running within a Sub-Heap " ° ∂ À | À0 ° ∂ ° ∂
° d ONLN dv – ~ ‹! *YA sub-heap for memory allocation is mandatory for Atom Extenders to prevent gridlock when ° d ONLN d– ‹ ~ Ë+ * abuffering data. Sub-heaps are optional for the other code resources that can be called during an ° d ONLN d2 Ë ~ Ù& * `installation, such as search procedures, Action Atoms and rule functions. We suggest some do’s ° d ONLN dì Ù ~ F * +and don’ts on dealing with sub-heaps below. ° d ONLN dø ~ ò *DO’s:
° d ONLN d≈ ~' Ö *n
° d ONLN d« ê( )WSub-heaps are mandatory for Atom Extenders, but other code resources can run inside the ° d ONLN d ( ê4 * ZInstaller’s heap, so enter 0 (size) as the request memory size if you don’t want to bother ° d ONLN dz4 ê@ ⁄ * with sub-heaps.
° d ONLN däJ ~S Ö (Q ~n
° d ONLN dåH êT( )\Set the current zone to the application heap before calling any Toolbox routine, and restore ° d ONLN dÈT ê`* * \it afterwards. This assures that memory allocated within these calls won’t get left in your ° d ONLN dF` êl Ω * sub-heap.
° d ONLN dPv ~ Ö (} ~n
° d ONLN dRt êÄ )WUse the Installer’s memory routines, unless you want the memory allocated directly from ° d ONLN d™Ä êå ” * your sub-heap. ° d ONLN dπî ~† ß (ù ~DON’Ts:
° d ONLN d¡™ ~≥ Ö *n
° d ONLN d√® ê¥" )[Watch out for memory that is left in the sub-heap after you return control to the Installer ° d ONLN d ¥ ê¿* * \that the system may have references to. If you set the current zone to the application heap ° d ONLN d|¿ êà * Xbefore calling any Toolbox routine you shouldn’t have any problems. For example, if you ° d ONLN d÷à êÿ * Xcall the GetResource routine (without properly setting the zone) that allocates a handle ° d ONLN d/ÿ ê‰ * Uinside your sub-heap the Installer may crash after returning control to the Installer
° d ONLN dÖÓ ~˜ Ö (ı ~n
° d ONLN dáÏ ê¯— )HNever return a reference to a handle allocated in your sub-heap for the ° d ONLN dœÏ—¯% (ı—fStaticDataHdl ° d ONLN dfi¯ ê& ( ê^field. Since the sub-heap is destroyed between invocations of the code resource, it’s best to ° d ONLN d= ê † * use ° d ONLN dA † ‹ )
INewHandle ° d ONLN dK ‹é )<) to allocate any handle you store in the ° d ONLN dté‚ )≤fStaticDataHdl ° d ONLN dÇ‚˛ )T field.
° d ONLN dã ~# Ö (! ~n
° d ONLN dç ê$ )UNever assume you received a sub-heap of the full size requested. Check that you have ° d ONLN d„$ ê0 * Xenough memory enough to complete your task, since the Installer calls you whether or not ° d ONLN d<0 ê< * Xyour full request was allocated. Look for warning messages in the Installer Debugger to ° d ONLN dï< êH * help identify this situation.
° d ONLN d€o ~{ *ZConversion is simple for those decompressors that access files using standard File Manager ° d ONLN d 6{ ~á$ * `calls. The Installer routines have been designed to easily replace calls to the high-level File ° d ONLN d óá ~ì± * ?Manager routines: FSRead, FSWrite, SetFPos, GetFPos and GetEOF. ° d ONLN d ◊õ ~ß, *_If your decompression code must use a temporary file to store partially decompressed data, then ° d ONLN d
7ß ~≥( * cit’s up to you to create and destroy this file. Space on the target disk can be reserved by adding ° d ONLN d
õ≥ ~ø* * athe needed space to one File Atom installed to the target disk. As an alternative, the Installer ° d ONLN d
˝ø ~À ∫ *
INewHandle ° d ONLN d ø ∫À% )<T routine can be used to allocate a temporary buffer if sufficient memory exists, but ° d ONLN d \À ~◊n (‘ ~4the availability of this memory is never guaranteed. ˇ¨ d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ] ( Z ~WIf your original decompression code comes from an application and you are using the MPW ° d ONLN d X ] ~ i) * ^development system, make sure to read Tech. Note #256. To access global data you will need to ° d ONLN d ∑ i ~ u * Wcreate your own A5 world and switch back to the Installer’s A5 world before calling any ° d ONLN d u ~ Å- * `Installer routine or Mac Toolbox trap. Avoiding global data makes writing code resources easier ° d ONLN dp Å ~ ç# * ]unless your development system (i.e. THINK C) supports using the A4 register to access global ° d ONLN dŒ ç ~ ô ó * data.
° d ONLN dÏ ~ ÷& +H`This section describes the data structures and routines that are used by Atom Extenders. You’ll ° d ONLN dM ÷ ~ ‚ * Vneed to include the interface file “AtomExtenderHeader.h” or “AtomExtenderHeader.p” to ° d ONLN d§ ‚ ~ ÓZ * 2have access to these data structures and routines.
° d ONLN dÏ ~#. +HaInformation about how to call the Atom Extender code resource is contained in the script resource ° d ONLN dN# ~/' * _of type ‘inex’. New versions of File Atoms, Resource Atoms and Font Atoms reference the ‘inex’ ° d ONLN dÆ/ ~;ê * ?resource using its resource ID. The resource has the template: ,
Courier ° d ONLN dÓK ~W ® * #define ° d ONLN dˆK ¥W )6atomExtenderFlags ° d ONLN dK¯W˛ (T¯\ ° d ONLN dV ¢b à (_ ¢boolean ° d ONLN d!V Íb» )H%dontSendInitMessage, sendInitMessage; ° d ONLN dIV¯b˛ (_¯\ ° d ONLN dMa ¢m à (j ¢boolean ° d ONLN dVa Ím‡ )H)dontSendBeforeMessage, sendBeforeMessage; ° d ONLN dÅa¯m˛ (j¯\ ° d ONLN dÖl ¢x à (u ¢boolean ° d ONLN dél Íx‘ )H'dontSendAfterMessage, sendAfterMessage; ° d ONLN d∑l¯x˛ (u¯\ ° d ONLN dªw ¢É à (Ä ¢boolean ° d ONLN dƒw ÍÉÏ )H+dontSendSuccessMessage, sendSuccessMessage; ° d ONLN dw¯É˛ (į\ ° d ONLN dÙÇ ¢é à (ã ¢boolean ° d ONLN d˝Ç Íé‡ )H)dontSendCancelMessage, sendCancelMessage; ° d ONLN d(Ç¯é˛ (ã¯\ ° d ONLN d,ç ¢ô à (ñ ¢boolean ° d ONLN d5ç Íô⁄ )H(continueBusyCursors, suspendBusyCursors; ° d ONLN d_ç¯ô˛ (ñ¯\ ° d ONLN dcò ¢§ (° ¢
fill bit[10]; ° d ONLN dqÆ ~∫ Ã (∑ ~
type 'inex' { ° d ONLN dÅπ ¢≈ “ +$ switch { ° d ONLN dçƒ ¥– +
case format0: ° d ONLN düœ Δ€& + key integer = 0; ° d ONLN d≤œV€ )ê /* Extender Format version */ ° d ONLN d‘⁄ ΔÊ2 („ ΔatomExtenderFlags; ° d ONLN dË⁄VÊÊ )ê/* Flags for Format 0 */ ° d ONLN d ΔÒ, (Ó Δunsigned longInt; ° d ONLN dÂVÒÊ )ê/* Code resource Type */ ° d ONLN d6 Δ¸ (˘ Δinteger ° d ONLN dCV¸⁄ )ê/* Code resource ID */ ° d ONLN d^˚ Δ ˆ ( ΔlongInt; ° d ONLN dl˚V¬ )ê/* Refcon Value */ ° d ONLN dÉ Δ ˆ ( ΔlongInt; ° d ONLN dëVÚ )ê/* Required Free Memory */ ° d ONLN d∞ Δ , ( ΔevenPaddedString; ° d ONLN dƒV Ê )ê/* Status Description */ ° d ONLN d‡ ¢( Æ (% ¢}; ° d ONLN d„' ~3 ä (0 ~};
° d ONLN dÊC ~N ‘ *Flag descriptions
° d ONLN d¯Q ~] ÿ *sendInitMessage ° d ONLN dQ]T )êAsks to send an ° d ONLN dQT]ñ )F kInitialize ° d ONLN d#Qñ], )B message to those Atom Extenders ° d ONLN dD]iÛ (f2attached to atoms that will be executed during the ° d ONLN dwiufi * .installation. The Atom Extender receives the ° d ONLN d•ifiu )– kInitialize ° d ONLN d±uÅ! (~>message after each time the user clicks the Install button and ° d ONLN dÅç€ * 0preflighting is successful. The purpose of the ° d ONLN d Å€ç )Õ kInitialize ° d ONLN d,çô. (ñ>message is to allocate any static memory needed to communicate ° d ONLN dkô• * between Atom Extenders. ° d ONLN dÉ≠ ~π ‰ (∂ ~sendBeforeMessage ° d ONLN dï≠πO )êAsks to send a ° d ONLN d§≠Oπë )A kBeforePart ° d ONLN dØ≠ëπ )B message to the Atom Extender ° d ONLN dÕπ≈ (¬<code resource when the atom part is ready to be copied. The ° d ONLN d
≈— * <Installer has found and opened the source file that the part ° d ONLN d G—› * ?exists in and is ready to begin buffering the source data. The ˇ d ˇ ˇˇˇˇ d
° d ONLN d Q ] ( Z7Atom Extender can override the Installer’s default copy ° d ONLN d 8 ] i * 8mechanism by using the supplied routines and returning a ,
Courier ° d ONLN d q i uP * kCopiedData ° d ONLN d | iP uÖ )B
result code. ° d ONLN d ä } ~ â fi ( Ü ~sendAfterMessage ° d ONLN d õ } âT )êAsks to send an ° d ONLN d ´ }T âê )F
kAfterPart ° d ONLN d µ }ê â )< message to the Atom Extender ° d ONLN d ” â ï- ( íAcode resource for each part that has been successfully written by ° d ONLN d ï °Æ * $the Installer or Atom Extender. An ° d ONLN d9 ïÆ °Í )†
kAfterPart ° d ONLN dC ïÍ ° )< message is ° d ONLN dO ° ≠ ( ™9only sent if the Installer performed the copy or the Atom ° d ONLN dâ ≠ πW * Extender called ° d ONLN dô ≠W π± )IWriteTargetData ° d ONLN d® ≠± π) )Z (with data length greater ° d ONLN d√ π ≈X ( ¬than 0) during a ° d ONLN d‘ πX ≈ö )J kBeforePart ° d ONLN dfl πö ≈ƒ )B message. ° d ONLN dÈ Õ ~ Ÿ Í ( ÷ ~sendSuccessMessage ° d ONLN d¸ Õ ŸO )êAsks to send a ° d ONLN d ÕO Ÿ )AkSuccess ° d ONLN d Õ Ÿ )0" message to the Atom Extender code ° d ONLN d6 Ÿ ½ ( ‚7resource after the entire installation has successfully ° d ONLN dn  Òö * completed. The purpose of the ° d ONLN dç Âö Ò )åkSuccess ° d ONLN dï  Ò# )0 message is to allow ° d ONLN d™ Ò ˝Ù ( ˙2disposal of any static memory allocated during the ° d ONLN d› ˝ P * kInitialize ° d ONLN dË ˝P )B- message, and delete any temporary files that ° d ONLN d ( (<were created by the Extender. Only those Atom Extenders that ° d ONLN dS!7 * received ° d ONLN d\7!y )) kInitialize ° d ONLN dgy!‰ )B messages will be sent a ° d ONLN dĉ! )kkSuccess ° d ONLN dâ!-6 (*message. ° d ONLN dî5 ~A ‰ (> ~sendCancelMessage ° d ONLN d¶5AO )êAsks to send a ° d ONLN dµ5OAy )AkCancel ° d ONLN dº5yA )*" message to the Atom Extender code ° d ONLN dflAM$ (J@resource when the user cancels the installation, an error forces ° d ONLN d MY * 9the installation to stop, or an Atom Extender cancels the ° d ONLN dZYe¢ * "installation. The purpose of the ° d ONLN d|Y¢eà )îkCancel ° d ONLN dÉYÃe+ )* message is to reverse ° d ONLN döeq (n7any changes that were made during the installation, and ° d ONLN d“q}Ô * 1dispose of any static memory allocated during the ° d ONLN d}âP * kInitialize ° d ONLN d}Pâ )B) message. Only those Atom Extenders that ° d ONLN d9âï7 (í received ° d ONLN dBâ7ïy )) kInitialize ° d ONLN dMâyï‰ )B messages will be sent a ° d ONLN dfâ‰ï )kkCancel ° d ONLN dnï°6 (ûmessage.
° d ONLN dw´ ~∂ ◊ (≥ ~Field descriptions
° d ONLN däπ ~≈ Í *Code Resource Type ° d ONLN dùπ≈ )ê:The resource type of the Atom Extender code resource to be ° d ONLN dÿ≈—[ * called. (4-bytes) ° d ONLN dÏŸ ~ fi (‚ ~Code Resource ID ° d ONLN d˝ŸÂ+ )ê@The resource ID of the Atom Extender code resource to be called. ° d ONLN d?ÂÒ7 * (2-bytes) ° d ONLN dJ˘ ~ Δ ( ~ RefCon Value ° d ONLN dW˘µ )ê%The value that will be passed in the ° d ONLN d|˘µfl )ßfRefCon ° d ONLN dɢfl )*
field of the ° d ONLN dëÕ ()Atom Extender parameter block. (4-bytes) ° d ONLN dº ~% ˆ (" ~Required Free Memory ° d ONLN d—%$ )ê;The minimum number of free bytes the Atom Extender needs in ° d ONLN d
%1 * 5its own heap to make local allocation of memory using ° d ONLN dC1=Ã * )Macintosh OS/Toolbox routines. (4-bytes) ° d ONLN dnE ~Q Í (N ~Status Description ° d ONLN dÅEQ- )ê@An optional string that is displayed in the Status dialog during ° d ONLN d¬Q] * ;execution of the Atom Extender. (even-padded Pascal string)
° d ONLN dˇq 6Å ú (} 6Data Structures " ° ∂ Å 4Å0 ° ∂ ° ∂
° d ONLN d Q ~ ] ( Z ~]The Atom Extender should return a result telling the Installer what to do after executing the ° d ONLN d ^ ] ~ i¨ * Gcode resource. You can use these constants to specify the result code: ,
Courier ° d ONLN d ¶ m ~ y “ *typedef enum { ° d ONLN d ∂ x ê Ñ ˆ + kFatalError = -1, ° d ONLN d À x2 Ñ )¢//* Stop installation with error user dialog. */ ° d ONLN d ¸ Ñ ê ê ( ç êkContinueAsNormal = 0, ° d ONLN d Ñ2 êÛ )¢,/* Request default action from Installer. */ ° d ONLN dB ê ê ú ( ô êkCancelInstallation = 1, ° d ONLN d[ ê2 ú )¢2/* Cancel installation with cancel user dialog. */ ° d ONLN dè ú ê ® Í ( • êkCopiedData = 2 ° d ONLN d¢ ú2 ®± )¢ /* Override default copy on ° d ONLN dæ ú± ®Û ) kBeforePart ° d ONLN d… úÛ ®) )B message. */ ° d ONLN d÷ ® ~ ¥ Ã ( ± ~
° d ONLN dÙ ÷ ~ ‚' +H[The AtomExtender parameter block contains information about the atom being installed. Most ° d ONLN dP ‚ ~ Ó * WAtom Extenders will only need to reference a few fields from this parameter block. The ° d ONLN d® Ó ~ ˙ * "parameter block has the structure: ° d ONLN dÀ ˛ ~
° d ONLN d Q ê ] Æ ( Z êshort ° d ONLN d Q ]z )~fTargetFontRsrcID; ° d ONLN d \ ê h ¥ ( e êStr255 ° d ONLN d * \ hÜ )~fTargetFontRsrcName; ° d ONLN d @ g ê s Æ ( p êshort ° d ONLN d K g så )~fTargetFontRsrcAttrs; ° d ONLN d b r ê ~ ¥ ( { êStr255 ° d ONLN d m r ~V )~ fFamilyName; ° d ONLN d { } ê â Æ ( Ü êshort ° d ONLN d Ü } âJ )~
fFamilyID; ° d ONLN d í à ê î Æ ( ë êshort ° d ONLN d ù à îJ )~
fMessageID ° d ONLN d¶! )ê8One of five messages the Atom Extender will receive when ° d ONLN dfl!-* * ?being called. Use these constants to understand the message ID: ° d ONLN d 5Ab *typedef enum { ° d ONLN d0@2Lí +$ kInitialize = 0, ° d ONLN dBK2Wt * kBeforePart ° d ONLN dNKzWí )H= 1, ° d ONLN dTV2bn (_2
kAfterPart ° d ONLN d_Vzbí )H= 2, ° d ONLN dea2mh (j2 kSuccess ° d ONLN doazmí )H= 3, ° d ONLN dul2x\ (u2kCancel ° d ONLN d}lzxå )H= 4 ° d ONLN dÅwÉÜ (Ä} ExtenderMessageID; ° d ONLN dóäñ *:Certain fields in the Atom Extender parameter block may or ° d ONLN d“ñ¢ * <may not be valid when receiving a specific message. Each of ° d ONLN d¢Æ& * >the following field descriptions include a note about when the ° d ONLN dNÆ∫N * field is valid. ° d ONLN d^¬ ~Œ “ (À ~fStaticDataHdl ° d ONLN dm¬Œ$ )ê9A handle created by the Atom Extender using INewHandle to ° d ONLN dߌ⁄ * 9save information between calls to this Atom Extender code ° d ONLN d·⁄Ê * 5resource. The field is always NULL when receiving an ° d ONLN dÊÚP * kInitialize ° d ONLN d"ÊPÚ )B/ message. You can assign a value to this field ° d ONLN dRÚ˛ (˚:during any call to the Atom Extender, and receive the same ° d ONLN dç˛
* <value in this field during the next message. (Valid for all ° d ONLN d
> *
messages.) ° d ONLN d’ ~* fi (' ~fCallBackProcPtr ° d ONLN dÊ *" )ê@A pointer to the Installer’s dispatcher routine. You’ll need to ° d ONLN d'*6 * <pass this field as a parameter to glue routines that provide ° d ONLN dd6B * 9access to Installer functions. (Valid for all messages.) ° d ONLN dûJ ~V “ (S ~fTargetVRefNum ° d ONLN d≠JV, )ê>The target disk’s vRefNum. When allowing the user to select a ° d ONLN dÏVb * :target application folder, this is the volume on which the ° d ONLN d'bnƒ * *folder resides. (Valid for all messages.) ° d ONLN dRv ~Ç Í ( ~fTargetFolderDirID ° d ONLN devÇ, )êBThe target application folder’s directory ID. This value is -1 if ° d ONLN d®Çé# * @the user cannot select a target application folder. Target File ° d ONLN dÈéö¬ * (Specs that use the reserved folder path ° d ONLN dé¬ö )¥ folder-user ° d ONLN d éö& )B will be ° d ONLN d%ö¶„ (£1placed in this folder. (Valid for all messages.) ° d ONLN dWÆ ~∫ “ (∑ ~fSystemVRefNum ° d ONLN dfÆ∫ )ê:The System disk’s vRefNum. Target File Specs that use the ° d ONLN d°∫Δn * reserved folder path ° d ONLN d∂∫nΔ∞ )` special-xxx ° d ONLN d¡∫∞Δ )B will be placed in the ° d ONLN dÿΔ“ (œ8System Folder on this volume. (Valid for all messages.) ˇF d ˇ ˇˇˇˇ d
Ê˛ )¥= 3, ° d ONLN dæ2$h (!2 kFontAtom ° d ONLN dÀÊ$¯ )¥= 4 ° d ONLN dœ#/P (, } DataType; ° d ONLN d‹6B *(Valid for all messages.) ° d ONLN dˆJ ~V ¿ (S ~ fSourceFile ° d ONLN dJV )ê:An FSSpec record specifying the source file from which the ° d ONLN d=Vb∞ * &source data is read. (Valid only for ° d ONLN dcV∞bÚ )¢ kBeforePart ° d ONLN dnVÚb )B and ° d ONLN dsbnJ (k
kAfterPart ° d ONLN d}bJn| )< messages.) ° d ONLN dâv ~Ç ¿ ( ~ fTargetFile ° d ONLN dïvÇ+ )ê?An FSSpec record specifying the target file to which the target ° d ONLN d’Çé† * "data is written. (Valid only for ° d ONLN d˜Ç†é‚ )í kBeforePart ° d ONLN dÇ‚éı )B and ° d ONLN déöJ (ó
kAfterPart ° d ONLN déJö| )< messages.) ° d ONLN d ¢ ~Æ fi (´ ~fTotalTargetSize ° d ONLN d.¢Æ& )ê@The number of bytes all source pieces will occupy in the target. ° d ONLN dpÆ∫U * (Valid only for ° d ONLN dÄÆU∫ó )G kBeforePart ° d ONLN dãÆó∫¨ )B and ° d ONLN dêƨ∫Ë )
kAfterPart ° d ONLN döÆË∫ )< messages.) ° d ONLN d¶¬ ~Œ ÿ (À ~fTargetPosStart ° d ONLN d∂¬Œ )ê;The offset in bytes into the target data the part’s data is ° d ONLN dÚŒ⁄ê * written. (Valid only for the ° d ONLN dŒê⁄“ )Ç kBeforePart ° d ONLN dŒ“⁄Á )B and ° d ONLN d ŒÁ⁄# )
kAfterPart ° d ONLN d≤˙˙, )< messages.) ° d ONLN dæ ~ ÿ ( ~fSourcePartSize ° d ONLN dŒ( )êAThe size in bytes the part’s data occupies in the source. (Valid ° d ONLN d&E *
only for the ° d ONLN d E&á )7 kBeforePart ° d ONLN d(á&µ )B
message.) ° d ONLN d3. ~: (7 ~fInstallerTempDirID ° d ONLN dG.: )ê=The directory ID of the Installer temp folder on the target’s ° d ONLN dÖ:F, * Dvolume that contains the original target file. If this field is -1, ° d ONLN d FR) * Bthe original file was not saved or did not exist. You can get the ° d ONLN d
R^§ * target’s volume refNum from the ° d ONLN d-R§^Ê )ñ fTargetFile ° d ONLN d8RÊ^& )B field. (Valid ° d ONLN dH^jE (g
only for the ° d ONLN dU^Ejá )7 kBeforePart ° d ONLN d`^ájú )B and ° d ONLN de^újÿ )
kAfterPart ° d ONLN do^ÿj
)< messages.)
° d ONLN d{t ~< (| ~%Field descriptions for Resource Atoms
° d ONLN d°Ç ~é ÿ *fSourceRsrcType ° d ONLN d±Çé )ê?The resource type of the source resource part. (Valid only for ° d ONLN dÒéöP * kBeforePart ° d ONLN d¸éPöe )B and ° d ONLN déeö° )
kAfterPart ° d ONLN d é°ö” )< messages.) ° d ONLN d¢ ~Æ Ã (´ ~
fSourceRsrcID ° d ONLN d%¢Æ )ê=The resource ID of the source resource part. (Valid only for ° d ONLN dcÆ∫P * kBeforePart ° d ONLN dnÆP∫e )B and ° d ONLN dsÆe∫° )
kAfterPart ° d ONLN d}Æ°∫” )< messages.) ° d ONLN d⬠~Œ ÿ (À ~fTargetRsrcType ° d ONLN dô¬Œ
)ê:The resource type of the target resource. (Valid only for ° d ONLN d‘Œ⁄P * kBeforePart ° d ONLN dflŒP⁄e )B and ° d ONLN d‰Œe⁄° )
kAfterPart ° d ONLN dÓŒ°⁄” )< messages.) ˇ@ d ˇ ˇˇˇˇ d
fTargetRsrcID ° d ONLN d Q ] )ê8The resource ID of the target resource. (Valid only for ° d ONLN d G ] iP * kBeforePart ° d ONLN d R ]P ie )B and ° d ONLN d W ]e i° )
kAfterPart ° d ONLN d a ]° i” )< messages.) ° d ONLN d m q ~ } ÿ ( z ~fTargetRsrcName ° d ONLN d } q } )ê=The resource name to be given to the target resource. (Valid ° d ONLN d ª } â3 * only for ° d ONLN d ƒ }3 âu )% kBeforePart ° d ONLN d œ }u âä )B and ° d ONLN d ‘ }ä âΔ )
° d ONLN dn ≥ ~ æ# ( ª ~!Field descriptions for Font Atoms
° d ONLN dê ¡ ~ Õ *fSourceFontRsrcType ° d ONLN d§ ¡ Õ$ )ê@The resource type of the source font resource part. (Valid only ° d ONLN dÂ Õ Ÿ * for ° d ONLN dÈ Õ Ÿ_ ) kBeforePart ° d ONLN dÙ Õ_ Ÿt )B and ° d ONLN d˘ Õt Ÿ∞ )
kAfterPart ° d ONLN d Õ∞ Ÿ‚ )< messages.) ° d ONLN d · ~ Ì ‰ ( Í ~fSourceFontRsrcID ° d ONLN d! · Ì* )êBThe resource ID of the source font resource part. (Valid only for ° d ONLN dd Ì ˘P * kBeforePart ° d ONLN do ÌP ˘e )B and ° d ONLN dt Ìe ˘° )
kAfterPart ° d ONLN d~ Ì° ˘” )< messages.) ° d ONLN dä ~
(
~fTargetFontRsrcType ° d ONLN dû
)ê?The resource type of the target font resource. (Valid only for ° d ONLN dfi
P * kBeforePart ° d ONLN dÈ
Pe )B and ° d ONLN dÓ
e° )
kAfterPart ° d ONLN d¯
°” )< messages.) ° d ONLN d! ~- ‰ (* ~fTargetFontRsrcID ° d ONLN d!-% )ê?The resource ID of the target font resource, which is not known ° d ONLN dV-9. * Buntil the part has been written by the Installer. (Valid only for ° d ONLN dô9E * the ° d ONLN dù9 E\ )
kAfterPart ° d ONLN dß9\Eé )< messages.) ° d ONLN d≥M ~Y (V ~fTargetFontRsrcName ° d ONLN d«MY. )êBThe resource name to be given to the target font resource. (Valid ° d ONLN d
Ye3 * only for ° d ONLN dY3eu )% kBeforePart ° d ONLN d Yueä )B and ° d ONLN d#YäeΔ )
kAfterPart ° d ONLN d-YΔe¯ )< messages.) ° d ONLN d9m ~y ˆ (v ~fTargetFontRsrcAttrs ° d ONLN dNmy )ê@The resource attributes to be given to the target font resource. ° d ONLN dêyÖU * (Valid only for ° d ONLN d†yUÖó )G kBeforePart ° d ONLN d´yóÖ¨ )B and ° d ONLN d∞y¨ÖË )
kAfterPart ° d ONLN d∫yËÖ )< messages.) ° d ONLN dΔç ~ô ¿ (ñ ~ fFamilyName ° d ONLN d“çô )ê7The family name (i.e. “Times”, “Geneva”… ). The source ° d ONLN d
ô•% * >‘FOND’ resource can be found using this name. (Valid only for ° d ONLN dI•±P * kBeforePart ° d ONLN dT•P±e )B and ° d ONLN dY•e±° )
kAfterPart ° d ONLN dc•°±” )< messages.) ° d ONLN doπ ~≈ ¥ (¬ ~ fFamilyID ° d ONLN dyπ≈. )ê>The family ID. Normally this is the resource ID of the ‘FOND’ ° d ONLN d∏≈—Ä * resource. (Valid only for ° d ONLN d”≈Ä—¬ )r kBeforePart ° d ONLN dfi≈¬—◊ )B and ° d ONLN d„≈◊— )
° d ONLN d" ~ +H\Version Compare functions allow external code resources to be called when the target file or ° d ONLN d ~&
* Xresource’s version must be determined in order to compare with the source version number ° d ONLN dÿ& ~2 ‚ * supplied in the script. ° d ONLN dÒ: ~F *ZThe Installer 3.X versions allow the scriptwriter to specify how it should handle the case ° d ONLN dLF ~R * [where the target file is newer than the source file. This usually prevents downgrading the ° d ONLN d®R ~^ * Zuser’s software, but the opposite case may occur where downgrading is required to maintain ° d ONLN d^ ~j * Zsync-ed versions of software. Previously, the determination of “newness” was dependent on ° d ONLN d^j ~v * acomparing the creation dates of the target file to the value in the source ‘infs’ resource. This ° d ONLN d¿v ~Ç£ * Cworks most of the time, but is not a reliable way to compare files. ° d ONLN d ä ~ñ& *aAll files being installed should have a version resource (‘vers’ 1 and maybe a ‘vers’ 2), and the ° d ONLN d fñ ~¢! * bability to “newness” of files based on version resource is a desirable feature. Installer 4.0 now ° d ONLN d …¢ ~Æ( * %provides three ways to compare files: ,
Zapf Dingbats
° d ONLN d Ô∏ ~¡ Ö *n
° d ONLN d Ò∂ ê¬; )&Old way using creation date. Use the ° d ONLN d
∂;¬π )´useSrcCrDateToCompare ° d ONLN d
,∂π¬ )~ flag in the File Atom.
° d ONLN d
DÃ ~’ Ö (” ~n
° d ONLN d
F ê÷ )ZDefault version number comparison using the ‘vers’ 1 resource in the target file. Use the ° d ONLN d
°÷ ê‚ * useVersProcToCompare ° d ONLN d
µ÷‚ )x? flag in the File Atom. Place the source version number in the ˇ¸ d ˇ ˇˇˇˇ d
° d ONLN d Q ê ] ( Z êSource Version Number ° d ONLN d Q ]ò )~! field and place 0 (zero) in the ° d ONLN d 6 Qò ]" )äVersion Compare Rsrc ID ° d ONLN d N ] ê i ˜ ( f êfield of the File Atom. ,
Zapf Dingbats
° d ONLN d f s ~ | Ö ( z ~n
° d ONLN d h q ê }+ )^Custom determination of the target version number of a file or resource using a code resource. ° d ONLN d » } ê â µ * Use the ° d ONLN d – } µ â- )%useVersProcToCompare ° d ONLN d ‰ }- â. )x; flag in the File Atom. Place the source version number in ° d ONLN d â ê ï ¢ ( í êthe ° d ONLN d$ â ¢ ï )Source Version Number ° d ONLN d9 â ïÁ )~/ field and place the ‘invc’ resource ID in the ° d ONLN dh âÁ ï )«Version ° d ONLN dp ï ê ° Í ( û êCompare Rsrc ID ° d ONLN d ï Í °¢ )Z) field of the File Atom or Resource Atom.
° d ONLN dŸ » ~ ‘- *`During preflighting of the target disk the Installer will call the Version Compare code resource ° d ONLN d: ‘ ~ ‡ * `for each existing target file that references a valid ‘invc’ script resource. Upon entering the ° d ONLN dõ ‡ ~ Ï# * ccode resource the current resource file will have been set to the target file, so the code resource ° d ONLN dˇ Ï ~ ¯% * _can easily make Resource Manager calls to read an alternative version resource. If the version ° d ONLN d_ ¯ ~ * `information is stored in the data fork, or in another file the code resource must open and close ° d ONLN d¿ ~ ⁄ * the file themselves. ° d ONLN d’ ~$# *_The Compare Version code resource must return the version number as the function result. If an ° d ONLN d5$ ~0¶ * Derror occurs while finding the version number, then return 0 (zero). ° d ONLN dz8 ~D≠ *CAllowable Installer functions when comparing the version of a file:
° d ONLN d ` êlK ))Action Handler function: RegisterAction.
° d ONLN d6Ä ~è€ (ã ~3Using Version Compare Functions with Resource Atoms " ° ∂ é |é0 ° ∂ ° ∂
° d ONLN djì ~ü- *`During preflighting of the target disk the Installer will call the Version Compare code resource ° d ONLN dÀü ~´, * dfor each existing target resource that references a valid ‘invc’ script resource. Upon entering the ° d ONLN d0´ ~∑$ * ccode resource the current resource file will have been set to the file the target resource resides. ° d ONLN dï∑ ~√F * .The code resource should call the Installer’s ° d ONLN d√∑F√ö )»ReadTargetData ° d ONLN d—∑ö√% )T routine to read from the target ° d ONLN dÚ√ ~œ( (à ~_resource. This should allow most resource version schemes using a header to easily and quickly ° d ONLN dRœ ~€* * ^determine the version number of the resource. Using Resource Manager calls should be avoided. ° d ONLN d≤„ ~Ô# *_The Compare Version code resource must return the version number as the function result. If an ° d ONLN dÔ ~˚¶ * Derror occurs while finding the version number, then return 0 (zero). ° d ONLN dW ~¿ *GAllowable Installer functions when comparing the version of a resource:
° d ONLN dÌ+ ê7fi )CTarget functions: ReadTargeData, GetTargeDataEOF, GetTargeDataPos, ° d ONLN d 17 êC „ * SetTargeDataPos.
° d ONLN d BM ~V Ö (T ~n
° d ONLN d DK êWK ))Action Handler function: RegisterAction.
° d ONLN d nk ~zw (v ~#Version Compare Runtime Environment " ° ∂ y |y0 ° ∂ ° ∂
° d ONLN d í~ ~ä *WThe Version Compare code resource shares memory space with the Installer. Local memory ° d ONLN d Íä ~ñ! * ]allocation using Memory Manager calls will come from the Installer’s heap. Please be nice to ° d ONLN d
° d ONLN d Q 6 ep ( ` 6"Version Compare Function Reference " ° ∂ e 4 e0 ° ∂ ° ∂
° d ONLN d # j ~ v( +HaThis section describes the function interface and resource descriptions needed to use the Version ° d ONLN d Ö v ~ Ç Ï * Compare script resource.
° d ONLN d û ñ 6 ¶ ™ ( ¢ 6Function Interface " ° ∂ ¶ 4 ¶0 ° ∂ ° ∂
° d ONLN d ± ´ ~ ∑ +HVThe Installer calls your Version Compare code resource assuming the following function ° d ONLN d ∑ ~ √ ™ *
interface. ,
Courier ° d ONLN d “ ~ fi§ *long ComputeVersionNumber( ComputeVersionPBPtr ); ° d ONLN dE Ï ~ ¯( *^The Version Compare function writer must return a version number. The version number consists ° d ONLN d§ ¯ ~ * Yof four bytes defined from the high byte as: major revision level, minor revision level, ° d ONLN d˛ ~u * 7development stage, and prerelease revision level. See ° d ONLN d5u )˜$Inside Macintosh: Macintosh Toolbox ° d ONLN dZ ~ ¨ ( ~
Essentials ° d ONLN dd ¨ ) ). , page 7-31 for more details.
° d ONLN dÇ0 6@ û (< 6Parameter Block " ° ∂ @ 4@0 ° ∂ ° ∂
° d ONLN díE ~Q +HYThe version compare code resource is passed a pointer to a parameter block containing the ° d ONLN dÏQ ~] À * callback pointer. ° d ONLN d˛a ~m ‰ *typedef struct { ° d ONLN dl êx ∫ + ProcPtr ° d ONLN dl ÍxP )ZfCallBackProcPtr; ° d ONLN d-w ~Ét (Ä ~)} ComputeVersionPB, *ComputeVersionPBPtr;
° d ONLN dWì ~û ◊ *Field descriptions
° d ONLN dk° ~≠ fi *fCallBackProcPtr ° d ONLN d|°≠ )ê>A pointer to the Installer’s dispatch routine. You’ll need to ° d ONLN dª≠π * 9pass this field as a parameter to Installer function glue ° d ONLN dıπ≈5 * routines.
° d ONLN dˇŸ 6È Ω ( 6Resource Description " ° ∂ È 4È0 ° ∂ ° ∂
° d ONLN dÓ ~˙¥ +HCThe template of the Version Compare script resource is shown below. ° d ONLN dX˛ ~
® *#define ° d ONLN d`˛ ¥
& )6versionCompareFlags ° d ONLN du˛D
J )ê\ ° d ONLN dy ¢ ( ¢
fill bit[16]; ° d ONLN dá ~+ Ã (( ~
type 'invc' { ° d ONLN dó* ¢6 “ +$ switch { ° d ONLN d£5 ¥A +
case format0: ° d ONLN dµ@ ΔL& + key integer = 0; ° d ONLN d«@DLº )~/* Format version */ ° d ONLN d‡K ΔW> (T ΔversionCompareFlags; ° d ONLN dıKDW¬ )~/* Version Compare */ ° d ONLN dV Δb& (_ Δliteral longint; ° d ONLN d!VDb )~$/* Version Compare Code Rsrc Type */ ° d ONLN dJa Δm ˆ (j Δinteger; ° d ONLN dWaDm )~"/* Version Compare Code Rsrc ID */ ° d ONLN d~l Δx ˆ (u Δlongint; ° d ONLN dãlDx¯ )~ /* Minimal Requested Memory */ ° d ONLN dÆw ΔÉ, (Ä ΔevenPaddedString; ° d ONLN d¡wDÉí )~
/* Summary */ ° d ONLN d“Ç ¢é Æ (ã ¢}; ° d ONLN d’ç ~ô ä (ñ ~};
° d ONLN d Q ~ ]2 ( Z ~ Version Compare Code Rsrc Type ° d ONLN d \ h +ê ;The resource type of the Version Compare code resource. (4 ° d ONLN d Z \ h ( e- ° d ONLN d [ h t* ( qbytes) ° d ONLN d b | ~ à& ( Ö ~ Version Compare Code Rsrc ID ° d ONLN d á ì- +ê @The resource ID of the Version Compare code resource. (2-bytes) ° d ONLN d ¿ õ ~ ß ( § ~Minimal Required Memory ° d ONLN d ÿ õ ß )ê9The minimum number of free bytes the Version Compare code ° d ONLN d ß ≥» * +resource needs during execution. (4-bytes)
° d ONLN dB Ω »* *NOTE
° d ONLN dK À ◊ *;Unless your Version Compare routine has a special need for ° d ONLN dä ◊ „! * <it's own memory heap, you should always assign this field a ° d ONLN d „ Ô * :value of zero. A value of zero allows the Version Compare ° d ONLN d Ô ˚„ * 0routine to use the Installer’s allocated memory. ,
Zapf Dingbats
° d ONLN d8 Ò„ ˙Í )’u
° d ONLN d: ~ ( ~Version Compare Summary ° d ONLN dR. )êAAn optional string briefly describing the purpose of this Version ° d ONLN dî * >Compare function. This string is never displayed to the user. ° d ONLN d‘'é * (even-padded Pascal string) ˇ d ˇ ˇˇˇˇ d
d , Palatino
. +~-C H A P T E R 4 , Helvetica
(Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ú79
$ ° d ONLN d Q ~ y` ( o ~Installer Rules " ° ∂ 40 ° ∂ ° ∂
° d ONLN d ~* *∏XThis chapter describes how to use Frameworks, Rules and Rule Clauses to make intelligent ° d ONLN d i* ~69 * )installation recommendations to the user.
° d ONLN d îN 6b ” (] 6Frameworks (‘infr’) " ° ∂ b 4b0 ° ∂ ° ∂
° d ONLN d ®g ~s +HX Rules are evaluated when the Installer is launched; and, when needed, while the user is ° d ONLN ds ~ * interacting with the interface. ° d ONLN d!á ~ì * Times when rules are evaluated: ,
Zapf Dingbats
° d ONLN dBù ~¶ Ö *n
° d ONLN dDõ êß' )\The rules are first evaluated immediately after the user dismisses the splash screen. If no ° d ONLN d°ß ê≥ * Ysplash screen is provided, then before showing the Easy Install or Custom Install dialog.
° d ONLN d˚Ω ~Δ Ö (ƒ ~n
° d ONLN d˝ª ê« )YThe user selects a different target disk, application folder or system disk while in Easy ° d ONLN dW« ê” * Install or Custom Install.
° d ONLN dr› ~Ê Ö (‰ ~n
° d ONLN dt€ êÁ )XThe user returns to the Installer from another application when running in a MultiFinder ° d ONLN dÕÁ êÛ À * environment.
° d ONLN d⁄˝ ~ Ö ( ~n
° d ONLN d‹˚ ê! )\The currently selected target disk changes because the user clicks the Eject Disk button, or ° d ONLN d9 ê * Yinserts a disk, or the disk goes offline because of a network failure or system activity.
° d ONLN d Q ~ ]( ( Z ~cwith Installer 3.4.X scripts that can use any ID for their ‘infr’ resource. It is recommended that ° d ONLN d d ] ~ iY * /the Easy framework resource have the ID of 764.
° d ONLN d î } ~ åB *" Custom Install Rule Framework " ° ∂ ã | ã0 ° ∂ ° ∂
° d ONLN d ≤ ê ~ ú- *_The Custom Install rule framework provides control over items shown in the Custom Install list. ° d ONLN d ú ~ ®( * ^When the Installer finds and opens the script, a Custom framework is located by looking for an ° d ONLN dr ® ~ ¥
* _‘infr’ resource of ID 766. If one is not found, the Installer uses the Installer 3.X method of ° d ONLN d“ ¥ ~ ¿√ * Fdetermining which packages should be shown in the Custom Install list. ° d ONLN d » ~ ‘+ *_When a Custom Install framework is found in the script, the scriptwriter must call the new rule ° d ONLN dy ‘ ~ ‡ ú * clause ,
Courier ° d ONLN dÄ ‘ ú ‡ Í )
AddCustomItem ° d ONLN dç ‘ Í ‡) )NI for each top-level item to be displayed in the Custom Install list. The ° d ONLN d◊ ‡ ~ Ï Ã ( È ~
AddCustomItem ° d ONLN d‰ ‡ à Ï* )NR rule clause accepts a list of the package (‘inpk’) IDs. The items will be listed ° d ONLN d7 Ï ~ ¯m ( ı ~4in the order they are added. Sub-packages with the ° d ONLN dk Ïm ¯ª )Ô
showsOnCustom ° d ONLN dx Ϫ ¯ı )N flag set will ° d ONLN dá ¯ ~ ( ~Yautomatically be added at the appropriate levels in the hierarchical Custom Install list. ° d ONLN d· ~ *ZLike the Easy Install framework, the Custom Install framework executes every time the user ° d ONLN d< ~$ * ]switches to Custom Install, changes the target disk/folder selection, or brings the Installer ° d ONLN dö$ ~0 ¶ * forward.
° d ONLN d•H 6\ õ (W 6Rules (‘inrl’) " ° ∂ \ 4\0 ° ∂ ° ∂
° d ONLN d¥a ~m +HYRules, which are organized by the rule framework, provide the intelligence for making the ° d ONLN dm ~yˇ * VEasy Install interface possible. Rules can examine the installation environment, save ° d ONLN dey ~Ö( * ^information about the installation environment to simplify other rules, provide information to ° d ONLN dƒÖ ~ë * \the user about what the Easy Install will do for them, report errors, and/or determine which ° d ONLN d!ë ~ù[ * 2packages will be used in the Easy Install process. ° d ONLN dT• ~±) *bRules are composed of one or more clauses. Each clause returns a boolean value. The first clause ° d ONLN d∑± ~ΩŒ * Mthat returns FALSE terminates the rule. If the terminated rule is part of a ° d ONLN d±ŒΩ (∫Œ pickFirst ° d ONLN d
±Ω )6 set in ° d ONLN dΩ ~…$ (Δ ~bthe rule framework then the following rule, if any, is evaluated. If all of the clauses in a rule ° d ONLN dx… ~’ õ * return ° d ONLN d… õ’ ≥ ) TRUE ° d ONLN dÉ… ≥’† )=, the rule is said to fire. If the firing rule is part of a ° d ONLN d¿…†’÷ )Ì pickFirst ° d ONLN d……÷’ )6 set in the rule ° d ONLN d⁄’ ~·t (fi ~6framework then no more rules in the set are evaluated. ° d ONLN dÈ ~ı) *_Clauses can be combined to develop the equivalent of an if-then statement. For example, the if ° d ONLN dpÈ)ı- (Ú)- ° d ONLN dqı ~ ≈ (˛ ~then statement: ° d ONLN dÅ ~\ *%IF the chosen target is a floppy disk ° d ONLN d® ~ Ê * <THEN use the package named floppyInstall in the Easy Install ° d ONLN dÂ) ~5b *&would be written as a rule as follows: ° d ONLN d B ~NJ *"resource 'inrl' (rFloppyInstall) { ° d ONLN d 0M êY Ã +
° d ONLN d Q ~ ] “ ( Z ~pFloppyInstall ° d ONLN d Q “ ]* )TT to the list of packages to be used in the Easy Install. So, if the first clause is ° d ONLN d c ] ~ i ñ ( f ~TRUE ° d ONLN d g ] ñ i´ )=, the addPackages clause will be TRUE and the rule will fire. ° d ONLN d • q ~ } ¿ ( z ~Clauses can be ° d ONLN d ¥ q ¿ } “ )BAND ° d ONLN d ∑ q “ }è )*ed together. For example, we could write: ° d ONLN d ‚ Å ~ ç\ ( ä ~%IF the chosen target is a floppy disk ° d ONLN d å ê òJ + AND we are installing on a Mac+ ° d ONLN d) ó ~ £‡ ( † ~;THEN return the package named floppyInstall to Easy Install ° d ONLN df ¢ ê Æ˛ + =AND add “• Mac+ Floppy Installation” to the Easy Install text ° d ONLN d§ ª ~ « ä ( ƒ ~as ° d ONLN dß ‘ ~ ‡J *"resource 'inrl' (rFloppyInstall) { ° d ONLN dÀ fl ê Î Ã +
format0 {{ ° d ONLN dÿ Í ¢ ˆh + !checkTgtVolSize {floppy, floppy}, ° d ONLN d¸ ı ¢⁄ * 4checkGestalt {gestaltMachineType, {gestaltMacPlus}}, ° d ONLN d3 ¢ \ * addPackages {{pFloppyInstall}}, ° d ONLN dU ¢» * 1addUserDescription {'• Mac+ Floppy Installation'} ° d ONLN dà ê" ¢ ( ê}}; ° d ONLN då! ~- ä (* ~}; ° d ONLN dè; ~GY *5This rule has four clauses. If the first two return ° d ONLN dƒ;YGq )€TRUE ° d ONLN d»;qG) )+ (i.e., we are installing onto a floppy and ° d ONLN dÙG ~S (P ~\the current machine is a Mac Plus) then the second two clauses will be evaluated. Note that ° d ONLN dQS ~_ ≤ * the clauses ° d ONLN d]S ≤_ Ù )4 addPackages ° d ONLN dhS Ù_ )B and ° d ONLN dmS _u )addUserDescription ° d ONLN dSu_∏ )l always return ° d ONLN déS∏_– )CTRUE ° d ONLN díS–_” ). ° d ONLN dîg ~s (p ~ZFor a more complete example, suppose you wanted to add a piece of text to the Easy Install ° d ONLN dÔs ~& * ]message which described the machine you were installing onto. The pseudo code is as follows: ° d ONLN dMÉ ~è *IF (Machine=Plus) THEN ° d ONLN deé êö‡ + 8Return the message 'Installing onto your Macintosh Plus' ° d ONLN dûô ~• (¢ ~ELSE IF (Machine=SE) THEN ° d ONLN d∫§ ê∞Œ + 5Return the message 'Installing onto your Macintosh SE ° d ONLN dØ ~ª (∏ ~ELSE IF (Machine=II) THEN ° d ONLN d ∫ êΔ‘ + 6Return the message 'Installing onto your Macintosh II' ° d ONLN dB◊ ~„ (‡ ~!The rule framework is as follows: ° d ONLN ddÁ ~Ûû *0resource 'infr' (kEasyInstallFrameworkRsrcID ) { ° d ONLN dñÚ ê˛ Ã +
format0 {{ ° d ONLN d£˝ ¢ t + #pickFirst, {rPlusUD, rSEUD, rIIUD}, ° d ONLN d» ê ú ( ê}} ° d ONLN dÀ ~ ä ( ~}; ° d ONLN dŒ- ~9Ñ *9The rules which this framework references are as follows: ° d ONLN d= ~I *resource 'inrl' (rPlusUD) { ° d ONLN d%H êT à +
\ ¢ hŒ + 2checkGestalt {gestaltMachineType, {gestaltMacII}}, ° d ONLN d B g ¢ sÏ * 7addUserDescription {'Installing onto your Macintosh II} ° d ONLN d { r ê ~ ¢ ( { ê}}; ° d ONLN d } ~ â ä ( Ü ~}; ° d ONLN d Ç ó ~ £ ¿ *The constants, ° d ONLN d ë ó ¿ £ )BrPlusUD, rSEUD ° d ONLN d ü ó £, )T, and ° d ONLN d • ó, £J )rIIUD ° d ONLN d ™ óJ £# ) 2 would be defined in the script before being used.
° d ONLN d › ∑ ~ Δ Á ( ¬ ~Using Assertions " ° ∂ ≈ | ≈0 ° ∂ ° ∂
° d ONLN d Ó ~ ÷# *bIt is often useful to keep track of information about the type of installation that is being done. ° d ONLN dR ÷ ~ ‚& * aThis allows a more natural script organization. Note: The Installer clears all assertions prior ° d ONLN d¥ ‚ ~ Ó * ^to firing rules. Suppose, for example, that many of the rules in a script depended on knowing ° d ONLN d Ó ~ ˙ * Zwhether an update or a new install was being done. The pseudocode for this is as follows: ° d ONLN dn ˛ ~
¸ *IF System File Exists ° d ONLN dÖ ê + AND Installing on Mac+ ° d ONLN dú ~ , ( ~ THEN Use Mac+ Update packages ° d ONLN d∫* ~6 ¸ *IF System File Exists ° d ONLN d—5 êA + AND Installing on MacSE ° d ONLN dÈ@ ~L2 (I ~ THEN Use MacSE Update packages ° d ONLN dZ ~f_ *0More conveniently (and with better performance): ° d ONLN d9j ~v ¸ *IF System File Exists ° d ONLN dOu ~Å ¸ * THEN Assert(updating) ° d ONLN deã ~ó ¿ * IF updating ° d ONLN drñ ê¢ + AND Installing on Mac+ ° d ONLN dâ° ~≠, (™ ~ THEN Use Mac+ Update packages ° d ONLN dß∑ ~√ ¿ * IF updating ° d ONLN d¥¬ êŒ + AND Installing on MacSE ° d ONLN dÃÕ ~Ÿ2 (÷ ~ THEN Use MacSE Update packages ° d ONLN dÎÁ ~Û *^Assertions provide this functionality. Using assertions is a three-step process: 1) define a ° d ONLN dJÛ ~ˇê * Aunique constant for the assertion, 2) set the assertion using an ° d ONLN dãÛêˇÿ (¸ê AddAssertion ° d ONLN dóÛÿˇ )H clause, and 3) ° d ONLN dߡ ~ Ì ( ~check the assertions via ° d ONLN d¿ˇ Ì À )o%CheckAllAssertions, CheckAnyAssertion ° d ONLN d¡À Œ )fi, ° d ONLN dÁ ~∂ ( ~4CheckMoreThanOneAssertion, CheckAllNonAssertions, or ° d ONLN d ~" ˆ * CheckAnyNonAssertion ° d ONLN d0 ˆ"ÿ )x3 clauses. The above example is written as follows: ° d ONLN dd& ~2 ‰ (/ ~#define aUpdating ° d ONLN dv& Í2 )l1 ° d ONLN dÄ&å2È )¢<-- uniquely defined ° d ONLN dï= ~Iò (F ~/resource 'infr' (kEasyInstallFrameworkRsrcID) { ° d ONLN dΔH êT à +
format0 {{ ° d ONLN d”S ¢_∂ + .pickAll, {rCheckUpdate, rSEUpdate, rIIUpdate}, ° d ONLN d^ êj ú (g ê}} ° d ONLN di ~u ä (r ~}; ° d ONLN d ~ã> * resource 'inrl' (rCheckUpdate) { ° d ONLN d+ä êñ Ã +
format0 {{ ° d ONLN d8ï ¢°å + 'checkFileRsrcForkExists {fsSystemFile}, ° d ONLN db† ¢¨> * addAssertion {{aUpdating}} ° d ONLN dņ娥 )Í
<-- set it ° d ONLN dç¨ ê∏ ¢ (µ ê}}; ° d ONLN dë∑ ~√ ä (¿ ~}; ° d ONLN dîÕ ~Ÿ, * resource 'inrl' (rSEUpdate) { ˇÿ d ˇ ˇˇˇˇ d
\ ¢ h\ + checkAllAssertions {aUpdating}, ° d ONLN d / \å h¡ )Í <-- check it ° d ONLN d > h ¢ tŒ ( q ¢2checkGestalt {gestaltMachineType, {gestaltMacSE}}, ° d ONLN d s s ¢ 8 * addPackages {{pSEUpdate}} ° d ONLN d é ~ ê ä ¢ ( á ê}}; ° d ONLN d í â ~ ï ä ( í ~}; ° d ONLN d ï ü ~ ´, * resource 'inrl' (rIIUpdate) { ° d ONLN d ¥ ™ ê ∂ à +
format0 {{ ° d ONLN d ¡ µ ¢ ¡V + checkAllAssertions {aUpdating} ° d ONLN d ‚ µå ¡¡ )Í <-- check it ° d ONLN d Ò ¡ ¢ ÕŒ ( ¢2checkGestalt {gestaltMachineType, {gestaltMacII}}, ° d ONLN d& à ¢ ÿ8 * addPackages {{pIIUpdate}} ° d ONLN dA ◊ ê „ ¢ ( ‡ ê}}; ° d ONLN dE ‚ ~ Ó ä ( Î ~};
° d ONLN d^ ~&Z +H2This section describes the available rule clauses. ° d ONLN dë* ~6V *$#define kEasyInstallFrameworkRsrcID ° d ONLN d∂*h6z )Í764 ° d ONLN d∫5 ~Ab (> ~&#define kCustomInstallFrameworkRsrcID ° d ONLN d·5hAz )Í766 ° d ONLN dÂ@ ~L8 (I ~ #define kGlobalFrameworkRsrcID ° d ONLN d@hLz )Í765
° d ONLN d [ 6k ∂ (g 6Global Rule Clauses
° d ONLN d Ä 6é ~ *# CheckGestalt " ° ∂ k 4k0 ° ∂ ° ∂ " ° ∂ é 4é0 ° ∂ ° ∂
° d ONLN d,£ ~؇ +H";CheckGestalt { gestaltSelector, {gestaltReturnValuesList} } ° d ONLN dhΩ ~… ® *gestalt ° d ONLN doΩ ®… Æ )*S ° d ONLN dpΩ Æ… ÿ )elector ° d ONLN dxΩ… )`=A selector value specifying the type of system information to ° d ONLN d∂…’X * check. (4-bytes) ° d ONLN d»› ~È (Ê ~gestaltReturnValuesList ° d ONLN d‡›È, )êBA list of Gestalt return values. If the Gestalt result matches one ° d ONLN d#Èı * <of the values in the list the function will return TRUE. (4 ° d ONLN d_Èı (Ú- ° d ONLN d`ı* (˛bytes)
° d ONLN dg
6 s ( 6 DESCRIPTION
° d ONLN ds ~( £ +HUse the ° d ONLN d{ £( Î )% CheckGestalt ° d ONLN dá Î(: )H clause to check a ° d ONLN dö :(d )OGestalt ° d ONLN d° d(ñ )*
attribute. ° d ONLN dÆ ñ(fi )2 CheckGestalt ° d ONLN d∫ fi( )H
takes two ° d ONLN d≈( ~4 ª (1 ~arguments: a ° d ONLN d”( ª4 Â )=Gestalt ° d ONLN d⁄( Â4c )* selector, and a list of valid ° d ONLN d˘(c4ç )~Gestalt ° d ONLN d (ç4% )*$ return values. The Installer calls ° d ONLN d%4 ~@ ® (= ~Gestalt ° d ONLN d,4 ®@6 )*" with the given selector. If the ° d ONLN dN46@` )éGestalt ° d ONLN dU4`@ )*, return value is in the list of valid return ° d ONLN dÇ@ ~L ° (I ~values, ° d ONLN dä@ °L È )# checkGestalt ° d ONLN dñ@ ÈL )H returns ° d ONLN dü@ L$ )#TRUE ° d ONLN d£@$L' ).
° d ONLN d•V ~a ö (^ ~NOTE
° d ONLN d™d ~p *aIf the Gestalt selector specified requires a value containing flags ( or a bit mask ), you should ° d ONLN d p ~| * 8use the CheckGestaltAttributes routine described below. ,
° d ONLN d Q ~ ] ® ( Z ~gestalt ° d ONLN d Q ® ] Æ )*S ° d ONLN d Q Æ ] ÿ )elector ° d ONLN d Q ] )`=A selector value specifying the type of system information to ° d ONLN d N ] iX * check. (4-bytes) ° d ONLN d ` q ~ } ® ( z ~bitMask ° d ONLN d h q } )ê:A bit mask that will be AND’ed with actual result from the ° d ONLN d £ } â8 * Gestalt ° d ONLN d ™ }8 â| )* call. (4-bytes)
° d ONLN d º ï 6 û s ( ú 6 DESCRIPTION
° d ONLN d » § ~ ∞ £ +HUse the ° d ONLN d – § £ ∞' )%CheckGestaltAttributes ° d ONLN d Ê §' ∞˜ )Ñ2 clause to check one or more specific bits in the ° d ONLN d §˜ ∞! )–Gestalt ° d ONLN d ∞ ~ º" ( π ~_value. Passing a bit mask with more than one bit set will effectively OR the specified bits in ° d ONLN dÄ º ~ » Ò * the Gestalt result value. ° d ONLN dõ º Ò »u )sCheckGestaltAttributes ° d ONLN d± ºu »‚ )Ñ takes two arguments: a ° d ONLN d º‚ » )mGestalt ° d ONLN d“ » ~ ‘E ( — ~/selector, and a bit mask. The Installer calls ° d ONLN d »E ‘o )«Gestalt ° d ONLN d »o ‘ä )* with ° d ONLN d »ä ‘‰ )gestaltSelector ° d ONLN d »‰ ‘ )Z , then AND’s ° d ONLN d* ‘ ~ ‡ · ( › ~the result value with ° d ONLN d@ ‘ · ‡ )cbitMask ° d ONLN dG ‘ ‡ñ )*". If this value is non-zero then ° d ONLN di ‘ñ ‡ )ãCheckGestaltAttributes ° d ONLN dÄ ‡ ~ Ï ü ( È ~returns ° d ONLN dà ‡ ü Ï ∑ )!TRUE ° d ONLN då ‡ ∑ Ï ∫ ).
° d ONLN dé 6 † ( 6CheckMinMemory " ° ∂ 40 ° ∂ ° ∂
° d ONLN dù' ~38 +H" CheckMinMemory{ minimalMemory } ° d ONLN dΩA ~M Ã *
minimalMemory ° d ONLN d A ÃM Œ )N ° d ONLN dÃAM )B6The minimal number of megabytes of physical memory. (4 ° d ONLN dAM (J- ° d ONLN dMY* (Vbytes)
° d ONLN d
e 6n s (l 6 DESCRIPTION
° d ONLN dt ~Ä ë +HUse ° d ONLN dt ëÄ Â )CheckMinMemory ° d ONLN d(t ÂÄ )T? to specify the minimal amount of physical memory needed for an ° d ONLN dhÄ ~å- (â ~(installation. Note that you cannot use ° d ONLN dêÄ-åu )Ø CheckGestalt ° d ONLN dúÄuå )H& for this job unless you want to list ° d ONLN d¬Äå )ôall ° d ONLN d≈Ä å' ) of ° d ONLN d…å ~òÜ (ï ~;the memory configurations applicable for an installation. ° d ONLN dåÜò⁄ (ïÜCheckMinMemory ° d ONLN då⁄ò )T takes a single ° d ONLN d"ò ~§M (° ~,argument: the minimal amount of memory (in ° d ONLN dNòM§Y )œMB ° d ONLN dPòY§⁄ ) ) needed for this clause to be ° d ONLN doò⁄§Ú )ÅTRUE ° d ONLN dsòÚ§ı ).
° d ONLN dçfl ~Îò +H"/CheckFileDataForkExists{ targetFileSpecRsrcID } ° d ONLN dΩ˘ ~ ˆ *targetFileSpecRsrcID ° d ONLN d—˘ ˆ ¯ )x ° d ONLN d”˘Δ )*A Target File Spec resource ID. (2-bytes)
° d ONLN d˛ 6 s ( 6 DESCRIPTION
° d ONLN d
~, ë +HUse ° d ONLN d ë, )CheckFileDataForkExists ° d ONLN d% , )ä: to determine whether a specific file has a data fork. It ° d ONLN d`, ~8Í (5 ~Ttakes a single argument: the Target File Spec ID of the file you are interested in. ° d ONLN dµ8 ~D * CheckFileDataForkExists ° d ONLN dÃ8D+ )ä returns ° d ONLN d’8+DC )#TRUE ° d ONLN dŸ8CD )3 if the file referenced by the File Spec exists and ° d ONLN d
D ~P « (M ~has a data fork.
° d ONLN d h 6v æ (r 6CheckFileRsrcForkExists " ° ∂ v 4v0 ° ∂ ° ∂
° d ONLN d6ã ~óò +H"/CheckFileRsrcForkExists{ targetFileSpecRsrcID } ° d ONLN df• ~± ˆ *targetFileSpecRsrcID ° d ONLN dz• ˆ± ¯ )x ° d ONLN d|•±Δ )*A Target File Spec resource ID. (2-bytes)
Courier ° d ONLN d Q ë ] )CheckFileRsrcForkExists ° d ONLN d Q ]% )ä> to determine whether a specific file has a resource fork. It ° d ONLN d Z ] ~ i ( f ~`takes a single argument: the Target File Spec ID of the file you are interested in. It returns ° d ONLN d ª i ~ u ñ * TRUE ° d ONLN d ø i ñ u… )H if the file referenced by the File Spec exists and has a resource fork. ° d ONLN d u ~ Å ( ~ ~CheckFileRsrcForkExists ° d ONLN d u Å! )äB is a convenient way to see if a file which contains code exists..
° d ONLN db ô 6 ß “ ( £ 6CheckFileContainsRsrcByID " ° ∂ ß 4 ß0 ° ∂ ° ∂
° d ONLN d| º ~ »Ú +H">CheckFileContainsRsrcByID{ targetFileSpecRsrcID, resourceType, ° d ONLN dª « ~ ” Δ * resourceID } ° d ONLN d» · ~ Ì ˆ *targetFileSpecRsrcID ° d ONLN d‹ · ˆ Ì ¯ )x ° d ONLN dfi · ÌΔ )*A Target File Spec resource ID. (2-bytes) ° d ONLN d ı ~ Δ ( ˛ ~ resourceType ° d ONLN d ı Δ » )H ° d ONLN d ıÉ )HA resource type. (4-bytes) ° d ONLN d3 ~ ∫ ( ~
resourceID ° d ONLN d= ∫ º )< ° d ONLN d? z )TA resource ID. (2-bytes)
° d ONLN dY! 6* s (( 6 DESCRIPTION
° d ONLN de0 ~<+ +HbMany times it is necessary to determine whether a specific file contains a specific resource. Use ° d ONLN d»< ~H ê * the ° d ONLN dÃ< êH& )checkFileContainsRsrcByID ° d ONLN dÂ<&H& )ñ9 clause to determine whether a file has a resource with a ° d ONLN d H ~T ⁄ (Q ~known type and ID. ° d ONLN d3H ⁄Tp )\checkFileContainsRsrcByID ° d ONLN dLHpT' )ñ) takes three arguments: the File Spec ID ° d ONLN dvT ~`µ (] ~Iof the target file, the type of the resource, and the ID of the resource.
° d ONLN d¿x 6Ü Ë (Ç 6CheckFileContainsRsrcByName " ° ∂ Ü 4Ü0 ° ∂ ° ∂
° d ONLN d‹õ ~߲ +H"@CheckFileContainsRsrcByName{ targetFileSpecRsrcID, resourceType, ° d ONLN d ¶ ~≤ “ * resourceName } ° d ONLN d,¿ ~à ˆ *targetFileSpecRsrcID ° d ONLN d@¿ ˆÃ ¯ )x ° d ONLN dB¿ÃΔ )*A Target File Spec resource ID. (2-bytes) ° d ONLN dm‘ ~‡ Δ (› ~ resourceType ° d ONLN dy‘ Δ‡ » )H ° d ONLN d{‘‡É )HA resource type. (4-bytes) ° d ONLN dóË ~Ù Δ (Ò ~ resourceName ° d ONLN d£Ë ΔÙ » )H ° d ONLN d•ËÙ› )H-A resource name. (even-padded Pascal string)
° d ONLN d” 6 s ( 6 DESCRIPTION
° d ONLN dfl ~ ë +HUse ° d ONLN d„ ë3 )checkFileContainsRsrcByName ° d ONLN d˛3 )¢2 to determine whether a file has a resource with a ° d ONLN d1 ~' Ê ($ ~known type and name. ° d ONLN dG Ê'à )hcheckFileContainsRsrcByName ° d ONLN dbà' )¢! takes three arguments: the File ° d ONLN dÑ' ~3Ê (0 ~SSpec ID of the target file, the type of the resource, and the name of the resource.
° d ONLN dÿK 6Y ö (U 6CheckFileVersion " ° ∂ Y 4Y0 ° ∂ ° ∂
° d ONLN dÈn ~z +H"CCheckFileVersion{ targetFileSpecRsrcID, majorVersNum, minorVersNum, ° d ONLN d-y ~Ö * releaseStage, releaseNum} ° d ONLN dGì ~ü ˆ *targetFileSpecRsrcID ° d ONLN d[ì ˆü ¯ )x ° d ONLN d]ìüΔ )*A Target File Spec resource ID. (2-bytes) ° d ONLN dàß ~≥ Δ (∞ ~ majorVersNum ° d ONLN dîß Δ≥ » )H ° d ONLN dñß≥∞ )H$The major version number. (2-bytes) ° d ONLN dªª ~« Δ (ƒ ~ minorVersNum ° d ONLN d«ª Δ« » )H ° d ONLN d…ª«± )H$The minor version number. (2-bytes) ˇ, d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ] Δ ( Z ~ releaseStage ° d ONLN d Q Δ ] » )H ° d ONLN d Q ]! )H?The release stage. Four release stage constants are defined in ° d ONLN d N ] i) * ?the InstallerTypes.r file: development, alpha, beta, final and ° d ONLN d é i u_ * release. (2-bytes) ° d ONLN d ¢ } ~ â ∫ ( Ü ~
releaseNum ° d ONLN d ¨ } ∫ â º )< ° d ONLN d Æ } âï )T The release number. (2-bytes)
° d ONLN d Õ ï 6 û s ( ú 6 DESCRIPTION
° d ONLN d Ÿ § ~ ∞ ë +HUse ° d ONLN d › § ë ∞ Ò )CheckFileVersion ° d ONLN d Ì § Ò ∞z )`" to check the version of a file. ° d ONLN d §z ∞⁄ )âCheckFileVersion ° d ONLN d §⁄ ∞ )`
takes two ° d ONLN d* ∞ ~ º. ( π ~carguments: the filespec ID of the file in question, and the minimal version of the file needed for ° d ONLN dé º ~ » » * this clause to be ° d ONLN d† º » » ‡ )JTRUE ° d ONLN d§ º ‡ »ÿ ):. The Installer obtains this information from the file’s ° d ONLN dfi ºÿ »¸ )¯'vers' ° d ONLN d‰ º¸ » )$ ID =1 ° d ONLN dÎ » ~ ‘ ø ( — ~resource. If no ° d ONLN d¸ » ø ‘ „ )A'vers' ° d ONLN d » „ ‘* )$ resource exists, ° d ONLN d »* ‘ä )GCheckFileVersion ° d ONLN d$ »ä ‘≠ )` returns ° d ONLN d- »≠ ‘À )#FALSE ° d ONLN d2 »À ‘Œ ) . ° d ONLN d4 ‹ ~ ËË (  ~RFor example, to check for System version 6.0.5 or newer, use the following clause. ° d ONLN dà Ï ê ¯∞ +0checkFileVersion{SysFileSpec, 6, 5, release, 0}; ° d ONLN dπ ˚ ~• ( ~CTo check for System version 7.1 or newer, use the following clause. ° d ONLN d˛ ê‘ +6checkFileVersion{FinderFileSpec, 7, 0x10, release, 0}; ° d ONLN d5 ~&ƒ (# ~ITo check for AppleTalk version 57.0.4 or newer, use the following clause. ° d ONLN dÄ* ê6‡ +8checkFileVersion{ATalkFileSpec, 0x57, 0x04, release, 0};
° d ONLN dπI 6W ∑ (S 6CheckFileCountryCode " ° ∂ W 4W0 ° ∂ ° ∂
° d ONLN dŒl ~x‘ +H"9CheckFileCountryCode{ targetFileSpecRsrcID, countryCode } ° d ONLN dÜ ~í ˆ *targetFileSpecRsrcID ° d ONLN d Ü ˆí ¯ )x ° d ONLN d ÜíΔ )*A Target File Spec resource ID. (2-bytes) ° d ONLN dIö ~¶ ¿ (£ ~ countryCode ° d ONLN dTö ¿¶ ¬ )B ° d ONLN dVö¶} )NA country code. (2 bytes)
° d ONLN dq≤ 6ª s (π 6 DESCRIPTION
° d ONLN d}¡ ~Õ £ +HUse the ° d ONLN dÖ¡ £Õ )%CheckFileCountryCode ° d ONLN dô¡Õ% )x= clause to determine a file’s country code (the name 'country ° d ONLN d◊Õ ~ŸW (÷ ~2code' has recently been changed to region code). ° d ONLN d ÕWŸœ )ŸCheckFileCountryCode ° d ONLN d ÕœŸ˝ )x
takes two ° d ONLN d(Ÿ ~ (‚ ~_arguments: the File Spec ID of the file in question, and the country/region code required. The ° d ONLN dà ~Ò[ * 3Installer obtains this information from the file’s ° d ONLN dªÂ[Ò )›'vers' ° d ONLN d¡ÂÒ )$! resource. The country (MPW 3.1) ° d ONLN d„Ò ~˝“ (˙ ~J/region (MPW 3.2) codes can be found in the MPW interface file SysTypes.r.
° d ONLN d. 6# ñ ( 6CheckTgtVolSize " ° ∂ # 4#0 ° ∂ ° ∂
° d ONLN d>8 ~DÄ +H"+CheckTgtVolSize{ minimumSize, maximumSize } ° d ONLN djR ~^ ¿ * minimumSize ° d ONLN duR ¿^ ¬ )B ° d ONLN dwR^˝ )N4The minimum size of the volume in Kbytes. (4-bytes) ° d ONLN d¨f ~r ¿ (o ~ maximumSize ° d ONLN d∑f ¿r ¬ )B ° d ONLN dπfrˇ )N4The maximum size of the volume in Kbytes. (4-bytes)
° d ONLN dÓ~ 6á s (Ö 6 DESCRIPTION
° d ONLN d˙ç ~ô £ +HUse the ° d ONLN dç £ô ˝ )%CheckTgtVolSize ° d ONLN dç ˝ô )ZD clause to check target disk size. Note that this check is for disk ° d ONLN dVô ~• (¢ ~]size (to distinguish floppy from hard disks), not available disk space. The Installer itself ° d ONLN d¥• ~± * Xhandles the case where the target has insufficient space to accomplish the installation. ° d ONLN d± ~Ω ÿ * CheckTgtVolSize ° d ONLN d ± ÿΩ )ZG takes two arguments: the smallest and largest size disks possible. To ° d ONLN deΩ ~…* (Δ ~]match any size disk, the minimal and maximal target disk sizes are both zero. If the minimum ° d ONLN d√… ~’ * [size is greater than zero but the maximum size equals zero, only the minimal requirement is ° d ONLN d ’ ~· * ]used. Note that there are three size pairs defined in InstallerTypes.r. If you use {floppy, ˇ` d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ] ( Z ~Yfloppy} then checkTgtVolSize will return TRUE for 400 or 800k floppy targets. If you use ° d ONLN d Z ] ~ i * R{hdFloppy, hdFloppy} then checkTgtVolSize will return TRUE for high density floppy ° d ONLN d ≠ i ~ u" * [(1.4mb) targets. If you use {hardDisk, hardDisk} then checkTgtVolSize will return TRUE for ° d ONLN d u ~ Å% * %any target volume of 10mb or greater.
° d ONLN d/ ã ~ ñ ö *NOTE
° d ONLN d4 ô ~ • *\Since RAM disks may be most any size, make sure your rules handle this situation correctly. ,
Zapf Dingbats
° d ONLN dê õ §# ( ¢ u
° d ONLN dí Ω 6 À ¶ ( « 6CheckRuleFunction " ° ∂ À 4 À0 ° ∂ ° ∂ ,
Courier
° d ONLN d§ ‡ ~ ÏÄ +H"+CheckRuleFunction{ ruleFunctionCodeRsrcID } ° d ONLN d– ˙ ~ *ruleFunctionCodeRsrcID ° d ONLN dÊ ˙ )Ñ ° d ONLN dË ˙ ) ?The resource ID of a RuleFunction resource (‘inrf’). (2-bytes)
° d ONLN d( 6 s ( 6 DESCRIPTION
° d ONLN d4! ~-" +H[Rule functions provide you with the ability to extend the rule-based decision-making scheme ° d ONLN dê- ~9π * Gusing a custom code resource written by you or someone else. When the ° d ONLN d◊-π9 (6πCheckRuleFunction ° d ONLN dÈ9 ~E (B ~\clause is evaluated the code resource is called and its return result determines whether the ° d ONLN dFE ~Q * clause returns TRUE or FALSE. ° d ONLN df[ ~g" *dTo call a rule function code resource, first create a Rule Function resource (‘inrf’) that describes ° d ONLN dÀg ~s' * ahow to call the code resource. The Rule Function resource is described in the “InstallerTypes.r” ° d ONLN d-s ~¿ * Gfile and the code resource can include the file “RuleFunctionHeader.h”. ° d ONLN duâ ~ïÍ *QWhen the code resource is called, the code resource receives the parameter block: ° d ONLN d«ô ~• fi *typedef struct { ° d ONLN dŸ§ ê∞ ∫ + ProcPtr ° d ONLN d„§ Í∞P )ZfCallBackProcPtr; ° d ONLN dˆØ êª Æ (∏ êshort ° d ONLN dˇØ ͪD )ZfTargetVRefNum; ° d ONLN d∫ êΔ ® (√ êlong ° d ONLN d∫ ÍΔ\ )ZfTargetFolderDirID; ° d ONLN d-≈ ê— Æ (Œ êshort ° d ONLN d6≈ Í—D )ZfSystemVRefNum; ° d ONLN dG– ê‹ ® (Ÿ êlong ° d ONLN dO– Í‹b )ZfSystemBlessedDirID; ° d ONLN de€ êÁ ® (‰ êlong ° d ONLN dm€ ÍÁ )ZfRefCon; ° d ONLN dvÊ ~Ún (Ô ~(} RuleFunctionPBRec, *RuleFunctionPBPtr;
° d ONLN dü ~
ö *NOTE
° d ONLN d§ ~ í *The ° d ONLN d® í ˛ )fTargetFolderDirID ° d ONLN d∫ ˛ & )lF field will be -1 if the Installer is using disk mode, the folder does ° d ONLN d ~(¨ (% ~Fnot exist, or a target File Spec referencing the reserved folder path ° d ONLN dG ¨(Ó (%¨ folder-user ° d ONLN dR Ó(' )B
has not been ° d ONLN d`( ~4 (1 ~Zreferenced by in another rule clause prior to calling the CheckRuleFunction rule clause.
° d ONLN d∫*3 (1u
° d ONLN dæG ~So (P ~6The code resource should use the function declaration: ° d ONLN dıW ~c ñ *long ° d ONLN d˙W ¢cn )$"RuleFunction( RuleFunctionPBPtr ); ° d ONLN d f ~r* (o ~^The function must return either a TRUE or FALSE value. Constants for these values are defined ° d ONLN d|r ~~ ã * as: ° d ONLN dÄÇ ~é8 * #define kTRUERuleFunctionResult ° d ONLN d†ÇDéJ )Δ1 ° d ONLN d¢ç ~ô> (ñ ~ #define kFALSERuleFunctionResult ° d ONLN d√çDôJ )Δ0
° d ONLN d’∑ ~√ *[If you choose to create a sub-heap for each invocation of the Rule Function please read the ° d ONLN d1√ ~œ * Ysection “Running with a Sub-Heap” within the Atom Extender portion of this document. You ˇh d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ] ( Z ~\can enter 0 (zero) in the requested memory field to not create a sub-heap and run inside the ° d ONLN d ] ] ~ i – * Installer’s heap. ,
Zapf Dingbats
° d ONLN d q _ – h ÿ )Rs
° d ONLN d s Å 6 è Ñ ( ã 6 AddAssertion " ° ∂ è 4 è0 ° ∂ ° ∂ ,
Courier
° d ONLN d Ä § ~ ∞b +H"&AddAssertion{ { assertionValueList } } ° d ONLN d ß æ ~ Í *assertionValueList ° d ONLN d π æ Í Ï )l ° d ONLN d ª æ ¸ )$7A list of 2-byte assertion values that you wish to set.
° d ONLN d Û ÷ 6 fl s ( › 6 DESCRIPTION
° d ONLN d ˇ  ~ Ò £ +HUse the ° d ONLN d  £ Ò Î )% AddAssertion ° d ONLN d  ΠҮ )H0 clause to set a list of 1 or more assertions. ° d ONLN dC ® Ò )Ω AddAssertion ° d ONLN dO  Ò% )H
takes a list ° d ONLN d] Ò ~ ˝¯ ( ˙ ~Uof assertion constants as arguments. The constants are uniquely defined Rez symbols. ° d ONLN d¥ ˝ ~ Δ * addAssertion ° d ONLN d¿ ˝ Δ
° d ONLN dÈD ~PÜ +H",CheckAllAssertions{ { assertionValueList } } ° d ONLN d^ ~j Í *assertionValueList ° d ONLN d(^ Íj Ï )l ° d ONLN d*^j )$9A list of 2-byte assertion values that you wish to check.
° d ONLN dw‰ ~Ä +H"+CheckAnyAssertion{ { assertionValueList } } ° d ONLN d£˛ ~
Í *assertionValueList ° d ONLN dµ˛ Í
Ï )l ° d ONLN d∑˛
)$9A list of 2-byte assertion values that you wish to check.
° d ONLN dÒ 6 s ( 6 DESCRIPTION
° d ONLN d˝% ~1 ë +HUse ° d ONLN d% ë1 ˜ )CheckAnyAssertion ° d ONLN d% ˜1Ó )f: to check if one or more constants are currently asserted. ° d ONLN dN1 ~= ‰ (: ~CheckAnyAssertion ° d ONLN d_1 ‰=Ω )f4 takes a list of assertion constants as arguments. ° d ONLN dì1Ω=# )ŸCheckAnyAssertion ° d ONLN d•= ~I ü (F ~returns ° d ONLN d≠= üI ∑ )!TRUE ° d ONLN d±= ∑I∑ )< if one or more of the items in the list have been asserted.
° d ONLN dÓa 6o · (k 6CheckMoreThanOneAssertion " ° ∂ o 4o0 ° ∂ ° ∂
° d ONLN dÑ ~ê∞ +H"3CheckMoreThanOneAssertion{ { assertionValueList } } ° d ONLN d<û ~™ Í *assertionValueList ° d ONLN dNû Í™ Ï )l ° d ONLN dPû™ )$9A list of 2-byte assertion values that you wish to check.
° d ONLN dä∂ 6ø s (Ω 6 DESCRIPTION
° d ONLN dñ≈ ~— +HCheckMoreThanOneAssertion ° d ONLN dØ≈— )ñ> is used to detect whether more than one constant in a list of ° d ONLN dÓ— ~› (⁄ ~#constants are currently asserted. ° d ONLN d—›® )îCheckMoreThanOneAssertion ° d ONLN d*—®›™ )ñ ° d ONLN d+—™› )takes a list of assertion ˇX d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ] ( Z ~$constants as arguments, and returns ,
Courier ° d ONLN d $ Q ]4 )ûTRUE ° d ONLN d ( Q4 ] )5 if more than one of the constants has been asserted. ° d ONLN d _ ] ~ i ( f ~CheckMoreThanOneAssertion ° d ONLN d x ] i# )ñ; could be used, for example, to determine whether more than ° d ONLN d ¥ i ~ u ( r ~`one printer is being installed. In that case, display a generic message reporting that “printer ° d ONLN d u ~ Å ˛ * software” is being installed.
° d ONLN d3 ô 6 ß é ( £ 6ClearAssertions " ° ∂ ß 4 ß0 ° ∂ ° ∂
° d ONLN dC º ~ »t +H")ClearAssertions{ { assertionValueList } } ° d ONLN dm ÷ ~ ‚ Í *assertionValueList ° d ONLN d ÷ Í ‚ Ï )l ° d ONLN dÅ ÷ ‚ )$9A list of 2-byte assertion values that you wish to clear.
° d ONLN d´9 6G ø (C 6CheckAllNonAssertions " ° ∂ G 4G0 ° ∂ ° ∂
° d ONLN d¡\ ~hò +H"/CheckAllNonAssertions{ { assertionValueList } } ° d ONLN dÒv ~Ç Í *assertionValueList ° d ONLN dv ÍÇ Ï )l ° d ONLN dvÇ )$9A list of 2-byte assertion values that you wish to check.
° d ONLN dUÂ 6Û ¿ (Ô 6CheckAnyNonAssertion " ° ∂ Û 4Û0 ° ∂ ° ∂
° d ONLN dj ~í +H".CheckAnyNonAssertion{ { assertionValueList } } ° d ONLN dô" ~. Í *assertionValueList ° d ONLN d´" Í. Ï )l ° d ONLN d≠". )$9A list of 2-byte assertion values that you wish to check.
° d ONLN dÁ: 6C s (A 6 DESCRIPTION
° d ONLN dÛI ~U ë +HUse ° d ONLN d˜I ëU )CheckAnyNonAssertion ° d ONLN d I U )x> to check if one or more constants are currently not asserted. ° d ONLN dKU ~a ˆ (^ ~CheckAnyNonAssertion ° d ONLN d_U ˆaÀ )x2 takes a list of assertion constants as arguments. ° d ONLN dìa ~m ˆ (j ~CheckAnyNonAssertion ° d ONLN dßa ˆm )x returns ° d ONLN d∞am1 )#TRUE ° d ONLN d¥a1m" ): if one or more of the items in the list are currently not ° d ONLN dÔm ~y ß (v ~ asserted.
° d ONLN d˘ë 6ü É (õ 6 AddAuditRec " ° ∂ ü 4ü0 ° ∂ ° ∂
° d ONLN d¥ ~¿∂ +H"4AddAuditRec{ targetFileSpecRsrcID, selector, value } ° d ONLN d:Œ ~⁄ ˆ *targetFileSpecRsrcID ° d ONLN dNŒ ˆ⁄ ¯ )x ° d ONLN dPŒ⁄Δ )*A Target File Spec resource ID. (2-bytes) ˇö d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ] Æ ( Z ~selector ° d ONLN d Q ]u )êThe selector. (4-bytes) ° d ONLN d " e ~ q ú ( n ~value ° d ONLN d ' e ú q û ) ° d ONLN d ) e qi )rThe value (4-bytes)
° d ONLN d > } 6 Ü s ( Ñ 6 DESCRIPTION
° d ONLN d J å ~ ò í +HThe ° d ONLN d N å í ò ‘ ) AddAuditRec ° d ONLN d Y å ‘ ò‚ )BB clause is used to add a record to a target file’s audit record. ° d ONLN d õ å‚ ò$ ( ï‚ AddAuditRec ° d ONLN d ß ò ~ §( ( ° ~btakes three arguments: a File Spec ID for the target file, an audit selector, and an audit value.
° d ONLN d
º 6 • ( Δ 6CheckAnyAuditRec " ° ∂ 4 0 ° ∂ ° ∂
° d ONLN d fl ~ Î" +H"FCheckAuditRec{ targetFileSpecRsrcID, auditSelector, {auditValueList} } ° d ONLN db ˘ ~ ˆ *targetFileSpecRsrcID ° d ONLN dv ˘ ˆ ¯ )x ° d ONLN dx ˘Δ )*A Target File Spec resource ID. (2-bytes) ° d ONLN d£
~ Ã ( ~
auditSelector ° d ONLN d±
u )êThe selector. (4-bytes) ° d ONLN d ! ~- “ (* ~auditValueList ° d ONLN dÿ! “- ‘ )T ° d ONLN d⁄!-u )<A list of 4-byte values.
° d ONLN dÛ9 6B s (@ 6 DESCRIPTION
° d ONLN dˇH ~T í +HThe ° d ONLN dH íT Ú )CheckAnyAuditRec ° d ONLN dH ÚT& )`D clause is used to determine whether a given selector and value have ° d ONLN dXT ~`È (] ~Tbeen entered into the audit record of a target file (specified by the File Spec ID). ° d ONLN dÆ` ~l fi * CheckAnyAuditRec ° d ONLN dæ` fil )`E takes three arguments: a File Spec ID for the target file, an audit ° d ONLN dl ~x (u ~aselector, and a list of audit values. If the value found in the audit resource for the specified ° d ONLN dfx ~ѧ * Dselector is contained in the list of values the clause returns TRUE.
° d ONLN d´ú 6™ é (¶ 6ReportVolError " ° ∂ ™ 4™0 ° ∂ ° ∂
° d ONLN d∫ø ~À, +H" ReportVolError{ errorString } ° d ONLN dÿŸ ~ ¿ * errorString ° d ONLN d„Ÿ ¿Â ¬ )B ° d ONLN d٦ )N#String to display. (Pascal String)
° d ONLN d Ò 6˙ s (¯ 6 DESCRIPTION
° d ONLN d˛ ~
“ +HReportVolError ° d ONLN d#˛ “
)TL is used to report an error because of a problem with the target disk (not a ° d ONLN dp
~ ( ~<hard disk, disk size too small, no system, et cetera). The ° d ONLN d¨
” (ReportVolError ° d ONLN d∫
” )T clause reports an ° d ONLN dÕ ~"• ( ~Cerror message in the Easy Install or Custom Install message area. ° d ONLN d•"˘ ( •ReportVolError ° d ONLN d ˘" )T always ° d ONLN d&" ~. ü (+ ~returns ° d ONLN d." ü. ∑ )!TRUE ° d ONLN d2" ∑. )U, so it can be called multiple times in a script. Messages are concatenated, just as ° d ONLN dà. ~: ó (7 ~with ° d ONLN dç. ó: )addUserDescription ° d ONLN dü.:§ )l'. Up to four lines can be displayed. ° d ONLN dΔ.§:¯ )°ReportVolError ° d ONLN d‘.¯: )T takes a ° d ONLN d›: ~F (C ~[single even-padded Pascal string as an argument. To insert the name of the volume into the ° d ONLN d9F ~R * string, place the characters " ° d ONLN dWFR
)É^O ° d ONLN dYF
Rq ) " in the desired place. ° d ONLN dsZ ~f ˚ (c ~ If the Installer evaluates a ° d ONLN dêZ ˚fO )}ReportVolError ° d ONLN dûZOf* )T2 clause, the Easy Install or Custom Install dialog ° d ONLN d—f ~r (o ~`displays a caution icon, and the Install button is dimmed. If you use this clause, the user can ° d ONLN d2r ~~ › * still switch volumes.
° d ONLN dHà ~ì ö *NOTE
° d ONLN dMñ ~¢ *WCalling ReportVolError from within the global framework may not work correctly for some ° d ONLN d•¢ ~Æ * \scripts. Depending on the rules within the easy or custom framework, the Install button may ° d ONLN dÆ ~∫) * _still be enabled. To solve this, call ReportVolError from within the easy or custom framework. ,
° d ONLN d t ~ Ä, +H" ReportSysError{ errorString } ° d ONLN d - é ~ ö ¿ * errorString ° d ONLN d 8 é ¿ ö ¬ )B ° d ONLN d : é ö¶ )N#String to display. (Pascal String)
° d ONLN d ^ ¶ 6 Ø s ( ≠ 6 DESCRIPTION
° d ONLN d j ≥ ~ ø “ +HReportSysError ° d ONLN d x ≥ “ ø& )TN is used to report an error because of a problem with the system the Installer ° d ONLN d « ø ~ À™ ( » ~Dis running on (usually unsupported hardware or a fatal error). The ° d ONLN d ø™ À˛ ( »™ReportSysError ° d ONLN d ø˛ À )T clause ° d ONLN d! À ~ ◊ ( ‘ ~^reports an error message to the Easy Install or Custom Install screen, which ever shows first. ° d ONLN dÅ ◊ ~ „ “ * ReportSysError ° d ONLN dè ◊ “ „ )T always returns ° d ONLN dü ◊ „1 )GTRUE ° d ONLN d£ ◊1 „- )=, so it can be called multiple times in a script. Up to four ° d ONLN d· „ ~ Ôú ( Ï ~Alines can be displayed. Messages are concatenated, just as with ° d ONLN d" „ú Ô ( ÏúAddUserDescription ° d ONLN d4 „ Ô )l. ° d ONLN d7 Ô ~ ˚ “ ( ¯ ~ReportSysError ° d ONLN dE Ô “ ˚ )TK takes a single even-padded Pascal string as an argument. If the Installer ° d ONLN dë ˚ ~ µ ( ~ evaluates a ° d ONLN dù ˚ µ )7ReportSysError ° d ONLN d´ ˚ )T= clause, the Easy Install or Custom Install dialog displays a ° d ONLN dÈ ~# ( ~bcaution icon, and the Install button is dimmed. If you use this clause, the user cannot switch or ° d ONLN dL ~ † * Ceject volumes from the interface and has only one option: to quit.
° d ONLN dê3 6C ‘ (? 6Easy Install Rule Clauses
° d ONLN d™X 6f ~ *# AddPackages " ° ∂ C 4C0 ° ∂ ° ∂ " ° ∂ f 4f0 ° ∂ ° ∂
° d ONLN d∂{ ~á\ +H"%AddPackages{ { assertionValueList } } ° d ONLN d‹ï ~° Ã *
packageIDList ° d ONLN dÈï ð Œ )N ° d ONLN dÎï°⁄ )B/A list of 2-byte package resource (‘inpk’) IDs.
° d ONLN d≠ 6∂ s (¥ 6 DESCRIPTION
° d ONLN d'º ~» í +HThe ° d ONLN d+º í» ‘ ) AddPackages ° d ONLN d6º ‘»˛ )BG clause is used to return a set of packages to the Easy Install screen. ° d ONLN d» ~‘ ¿ (— ~ AddPackages ° d ONLN dä» ¿‘ )BI can be called multiple times from a script, and the packages are unioned ° d ONLN d‘‘ ~‡ ¨ (› ~ together. ° d ONLN dfl‘ ¨‡ Ó ). AddPackages ° d ONLN dÍ‘ Ó‡´ )B, takes a list of package IDs as arguments. ° d ONLN d‘´‡Ì )Ω addPackages ° d ONLN d!‘̇ )B always ° d ONLN d)‡ ~Ï ü (È ~returns ° d ONLN d1‡ üÏ ∑ )!TRUE ° d ONLN d5‡ ∑Ï ∫ ).
° d ONLN dJ' ~3P +H"#AddUserDescription{ messageString } ° d ONLN dnA ~M “ *messageString ° d ONLN d}AM¶ )ê#String to display. (Pascal String)
° d ONLN d°Y 6b s (` 6 DESCRIPTION
° d ONLN d≠h ~t ë +HUse ° d ONLN d±h ët ˝ )AddUserDescription ° d ONLN d√h ˝t )l> to add to the text which is shown in the Easy Install dialog. ° d ONLN dt ~Ä Í (} ~AddUserDescription ° d ONLN dt ÍÄ- )lI takes a single even-padded Pascal string as an argument. The text to be ° d ONLN d_Ä ~å» (â ~Fadded is appended to whatever text has been previously added using the ° d ONLN d¶å ~ò Í * AddUserDescription ° d ONLN d∏å Íòß )l- clause. Up to four lines can be displayed. ° d ONLN dÂåßò )Ω AddUserDescription ° d ONLN d˘ò ~§ √ (° ~always returns ° d ONLN dò √§ € )ETRUE ° d ONLN d ò €§" )J. Note that the Installer will not supply introductory information so you ° d ONLN dW§ ~∞ ˚ (≠ ~ need to say something like: ° d ONLN ds§ ˚∞fl )}&“Click the Install button to install\n ° d ONLN dô§fl∞ )‰
{your product ° d ONLN dß∞ ~º Õ (π ~here}.” Use the " ° d ONLN dπ∞ Õº Ÿ )O\n ° d ONLN dª∞ Ÿº ) F" characters to insert a return character into the description string. ˇT d ˇ ˇˇˇˇ d
° d ONLN d € Ê ~ Ú í +HThe ° d ONLN d fl Ê í Ú Ê )AddCustomItems ° d ONLN d Ì Ê Ê Ú )TC rule clause appends the specified packages to the top level of the ° d ONLN d1 Ú ~ ˛Y ( ˚ ~5custom install list regardless of the setting of its ° d ONLN df ÚY ˛ß )€
showsOnCustom ° d ONLN ds Úß ˛ )N flag. Each package is ° d ONLN dã ˛ ~
Å ( ~9appended in the order listed. All sub-packages with the ° d ONLN dƒ ˛Å
œ (Å
showsOnCustom ° d ONLN d— ˛œ
)N
flag set are ° d ONLN dfl
~2 ( ~&appended at the appropriate sub-level. ˇ
d ˇ ˇˇˇˇ d
d , Palatino
. +~6C H A P T E R 5 , Helvetica
(Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ú93
$ ° d ONLN d Q ~ yã ( o ~File Specification " ° ∂ 40 ° ∂ ° ∂
° d ONLN d ~*+ *∏bThis chapter describes how to create the script resources that specify the source and target file.
° d ONLN d vB 6V (Q 6About File Specifications " ° ∂ V 4V0 ° ∂ ° ∂
° d ONLN d ê[ ~g. +HdMost atoms require a source and target file to be specified in order to carry out the action defined ° d ONLN d ıg ~s * \by the atom. For example, when using a File Atom to copy a file from the source disk to the ° d ONLN dRs ~ * btarget disk, a Target File Spec resource (‘intf’) and a Source File Spec resource (‘infs’) must be ° d ONLN dµ ~ã Ú * referenced from the atom.
° d ONLN dœï ~† ö *NOTE
° d ONLN d‘£ ~Ø" *^When performing installations from some network servers, it is necessary that all source files ° d ONLN d3Ø ~ª, * `have a file creation and modification time stamp that has an even value for the seconds. If you ° d ONLN dîª ~« * \intend for installation to be performed from network servers you should set the creation and ° d ONLN dÒ« ~”Δ * Lmodification times of all your source files to a value such as 12:00:00 PM. ,
° d ONLN d` ~ +H`The goal of the Target File Spec is to specify where to install the file on the target disk. In ° d ONLN d¡ ~ ( * `most cases the scriptwriter can hard code the path to the target file using the various reserved ° d ONLN d" ~(› * Rfolder path names, or in special cases, search for the file using a code resource. ° d ONLN du0 ~< *_The path to the target file that must start with a colon or one of two reserved tokens (special ° d ONLN d‘0 <$ (9 - ° d ONLN d’< ~H (E ~Zxxxx or folder-user). Because the target volume name is not known at the time a script is ° d ONLN d0H ~T$ * _written, the scriptwriter supplies a partial path name that begins in the root directory of the ° d ONLN dêT ~` ≥ * target disk.
° d ONLN dût ~É4 *" Installing into Special Folders " ° ∂ Ç |Ç0 ° ∂ ° ∂
° d ONLN dæá ~ì *YA scheme is provided to support special folders such as the System Folder, the Apple Menu ° d ONLN dì ~ü * [Folder, and other Folder Manager folders. The short-hand notation used to specify a folder ° d ONLN dtü ~´ ‘ * manager folder is “ ,
Courier ° d ONLN dáü ‘´ )V special-xxxx ° d ONLN dìü ´ )H8”, where the “xxxx” is one of the defined special folder ° d ONLN dô ~∑ (¥ ~\types. The special folder types currently defined for System 7.0 through 7.1 are as follows: ° d ONLN d)ø ~À ï *Type ° d ONLN dˇˇ ) ° d ONLN dˇˇ ) ° d ONLN d/ø ΔÀ ‰ )1Folder ° d ONLN d6À ~◊ ¢ (‘ ~'macs' ° d ONLN d=À Δ◊, )HBlessed System Folder ˇ¢ d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ] ¢ ( Z ~'prnt' ° d ONLN d Q Δ ]S )H PrintMonitor Documents Folder ° d ONLN d % ] ~ i ¢ ( f ~'strt' ° d ONLN d , ] Δ i )HStartup Folder ° d ONLN d ; i ~ u ¢ ( r ~'amnu' ° d ONLN d B i Δ u8 )HApple Menu Items Folder ° d ONLN d Z u ~ Å ¢ ( ~ ~'extn' ° d ONLN d a u Δ Å )HExtensions Folder ° d ONLN d s Å ~ ç ¢ ( ä ~'pref' ° d ONLN d z Å Δ ç )HPreferences Folder ° d ONLN d ç ç ~ ô ¢ ( ñ ~'ctrl' ° d ONLN d î ç Δ ô( )HControl Panels Folder ° d ONLN d ™ ô ~ • ¢ ( ¢ ~'font' ° d ONLN d ± ô Δ •~ )H)Fonts Folder (applies to System 7.1 only) ° d ONLN d € ≠ ~ π˙ ( ∂ ~UThis means that if the fully qualified path to the system file on the target disk was ° d ONLN d1 π ~ ≈
* Q“MyVolume:MyFolder:MySystemFolder:System”, then a reference to the special folder ° d ONLN dÉ ≈ ~ —{ * 7“special-macs” would be expanded by the installer to be ° d ONLN dª — ~ ›. * Z“MyVolume:MyFolder:MySystemFolder.” For example, if you wanted to install the Finder file ° d ONLN d › ~ È( * ]into the blessed folder on the system disk, you would use the path name “special-macs:Finder” ° d ONLN dt È ~ ı * ^in the File Spec. If a folder in the path name does not exist, the Installer creates it. The ° d ONLN d” ı ~ * \Installer supports the use of special folders even when running on systems which do not have ° d ONLN d0 ~
* ZFolder Manager functionality. For more information about the Folder Manager, refer to the ° d ONLN dã
~ œ * Finder chapter in ° d ONLN dù
œS )QInside Macintosh, Volume VI ° d ONLN d∏
SV )Ñ. ° d ONLN dº! ~-+ (* ~`To support installing into pre-7.0 systems, the Installer will automatically map special folders ° d ONLN d - ~9 * ^to the System Folder. For example, if your target is the Extensions Folder then the Installer ° d ONLN d|9 ~E, * _will change the destination to the System Folder rather than create an Extensions Folder. This ° d ONLN d‹E ~Q$ * balso applies to rule clauses that reference a file spec. While this simplifies script writing for ° d ONLN d?Q ~]’ * Nmany files that go into special folders, it does not simplify DA installation. ° d ONLN dée ~q *WLocalized systems are supported through a defined algorithm for determining the correct ° d ONLN dÊq ~}, * bspecial folder name by searching for the proper ‘fld#’ resource. Given a special folder type, the ° d ONLN dI} ~⃠* LInstaller searches for the type in a ‘fld#’ resource in the following order: ,
Zapf Dingbats
° d ONLN dñì ~ú Ö *n
° d ONLN dòë êù Á )Installer script file
° d ONLN dÆß ~∞ Ö (Æ ~n
° d ONLN d∞• ê± ‰ )Target System file
° d ONLN d√ª ~ƒ Ö (¬ ~n
° d ONLN d≈π ê≈ )Installer application file
° d ONLN d‡œ ~ÿ Ö (÷ ~n
° d ONLN d‚Õ êŸ Ê )Booted System file ° d ONLN dı· ~Ì- (Í ~dGenerally, the scriptwriter should not include a ‘fld#’ resource in the script so installations into ° d ONLN dZÌ ~˘X * /localized System Folders will happen correctly.
° d ONLN dä
~ ∏ *"4Installing into the User-Selected Application Folder " ° ∂ |0 ° ∂ ° ∂
° d ONLN dø ~, *]The scriptwriter can easily install or remove files and resources from the application folder ° d ONLN d , ~8 * \selected by the user. This reserved folder name should only be used in conjunction with the ° d ONLN dz8 ~D * \application folder interface mode. For example, to install the file “Demo Application” into ° d ONLN d◊D ~PÎ * Mthe application folder the path name might be “folder-user:Demo Application”.
° d ONLN d %d ~s´ *"-Managing Rollbacks on Multiple Target Volumes " ° ∂ r |r0 ° ∂ ° ∂
° d ONLN d Sw ~É# *^With the ability to install onto more than one target volume at a time, a complete rollback is ° d ONLN d ≤É ~è# * `not possible unless the original files on all target volumes are maintained. This is not always ° d ONLN d
è ~õ * [possible due to available disk space on the target volumes. The Installer always saves the ° d ONLN d
oõ ~ß+ * aoriginal System Folder files on the boot volume, but makes the saving of all other original files ° d ONLN d
—ß ~≥) * _optional based on the amount of available disk space on each target volume. If there is enough ° d ONLN d 1≥ ~ø * ^space to save all original files on all target volumes the ‘Cancel’ button shows in the Status ° d ONLN d êø ~ÀÎ * Qdialog thereby allow for a complete rollback, otherwise a ‘Stop’ button is shown. ˇ^ d ˇ ˇˇˇˇ d
° d ONLN d Q ~ `T ( \ ~$Installing onto the Installer Volume " ° ∂ _ | _0 ° ∂ ° ∂
° d ONLN d % d ~ p *_To support installation onto the Installer volume, the Installer must prevent source files from ° d ONLN d Ö p ~ |& * `being disturbed. After the user clicks the Install button, the Installer determines whether any ° d ONLN d Ê | ~ à! * etarget file matches the location of a source file. If there is a conflict the user is alerted. This ° d ONLN dL à ~ î * ]case is much more likely to happen when the scriptwriter allows the user to select the target ° d ONLN d™ î ~ † ’ * application folder.
° d ONLN dæ ¥ ~ √Q *""Setting the Finder flags and Dates " ° ∂ ¬ | ¬0 ° ∂ ° ∂
° d ONLN d· « ~ ”¯ *VFormat 1 of the ‘intf’ resource supports supplying the Finder flags, creation date and ° d ONLN d8 ” ~ fl& * amodification date to make target file specification of archived files easier. The Installer sets ° d ONLN dö fl ~ Î, * gthe values of a newly created file to the specified values in the ‘intf’. If the ‘intf’ is referenced ° d ONLN d Î ~ ˜ * Wfrom a File or ResMerge Atom and the file already exists the Finder flags, creation and ° d ONLN dZ ˜ ~* * ]modification dates will be updated. The Finder Flags in a File Atom will always override the ° d ONLN d∏ ~B * .Finder Flags specified in the ‘intf’ resource. ° d ONLN dÁ ~#. *hIf you use an ‘infs’ or format 0 of the ‘intf’ the Installer continues to use the Finder flags, creation ° d ONLN dP# ~/* * band modification date of the source file. In cases where the source file is a compressed archive, ° d ONLN d≥/ ~; * ]format1 version of the ‘intf’ is recommended. ScriptCheck will fill in the correct flags and ° d ONLN d; ~G" * _dates if the file does not reference an Atom Extender. If an Atom Extender is being used, make ° d ONLN dqG ~S% * ^sure to supply the appropriate ScriptCheck extension. To have ScriptCheck fill in the correct ° d ONLN d–S ~_* * _values, place a zero in the Finder flags field and 1 in the Creation Date and Modification Date ° d ONLN d0_ ~k. * efields. If the date field is zero or 1, the Installer reverts to the older method of determining the ° d ONLN dñk ~wp * 9correct target date, such as with format 0 of the ‘intf’.
° d ONLN dÒ® ~¥- +HcThe goal of the Source File Spec is to describe where the file resides on the original distribution ° d ONLN dU¥ ~¿ ≤ * source disk.
° d ONLN db‘ ~„ *"Source Disk Search Path " ° ∂ ‚ |‚0 ° ∂ ° ∂
° d ONLN dzÁ ~Û- *`Because of multiple disk installation capability, the semantics of the File Name field are a bit ° d ONLN d€Û ~ˇ * Ycomplex. Customers may have copied the distribution disks onto a file server and want to ° d ONLN d5ˇ ~ % * [install from there, or they may have made floppy backup copies of the system disks provided ° d ONLN dë ~ * ^by Apple and expect to be able to install from those. They might also want to set up a server ° d ONLN d ~# * _that users can install from. In either case, the path name specified in the File Name field of ° d ONLN d P# ~/, * _the Source File Spec will probably be slightly off (e.g. the backup disks may not have the same ° d ONLN d ∞/ ~;( * _names as the originals) so we need to be somewhat flexible when searching for a specific source ° d ONLN d
; ~G. * bfile. In a Source File Spec, the full path name (including volume name) must be given in the File ° d ONLN d
sG ~SØ * EName field, but it may not be used by the Installer exactly as given. ° d ONLN d
π[ ~g *_While the Installer is flexible as to exact volume names, it requires that disk contents be the ° d ONLN d g ~s * ^same as what is specified in the script. The Installer uses the scripts to make a list of the ° d ONLN d xs ~( * _volumes that are needed for the installation, and the files that should be on each volume. All ° d ONLN d ÿ ~ã( * ^files that are supposed to be on the same volume must be on the same volume, but that volume’s ° d ONLN d 7ã ~ó! * ^name may be different from the name given in the script. In addition, we relax this condition ° d ONLN d ñó ~£ * [slightly to allow for hard disk and network installations. When the Installer needs a disk ° d ONLN d Ú£ ~Ø * <specified in the script, it searches in the following order: ,
Zapf Dingbats
° d ONLN d
/π ~¬ Ö *n
° d ONLN d
1∑ ê√Ï )MSearch for a folder with the disk’s name at the same HFS level as the script.
° d ONLN d
Õ ~÷ Ö (‘ ~n
° d ONLN d
ÅÀ ê◊‹ )JSearch for a folder with the disk’s name at the script parent’s HFS level. ˇ d ˇ ˇˇˇˇ d
Courier ° d ONLN dIâ ´ï œ )-noCopy ° d ONLN dOâ œï ‰ )$ and ° d ONLN dTâ ‰ï> )deleteOnInstall ° d ONLN dcâ>ïñ )Z flags are set in the ° d ONLN dyâñï∫ )X'infs' ° d ONLN dâ∫ï‡ )$ resource
° d ONLN dûΔ ~“ +H^This section describes the data structures and script resources needed to reference source and ° d ONLN d˝“ ~fi Ë * target files from atoms.
° d ONLN d, ~ +HbThe section describes the resource definitions for the target file specification resource (‘intf’) ° d ONLN dè ~ X * 4and the source file specification resource (‘infs’).
° d ONLN dƒ3 6A Î (= 6#Target File Spec. Resource (‘intf’) " ° ∂ A 4A0 ° ∂ ° ∂
° d ONLN dËF ~R +HZThe new Target File Spec. resource contains a reference to an ‘insp’ script resource which ° d ONLN d CR ~^ * ]describes the file searching code resource, much like the Atom Extender script resource does. ° d ONLN d ¢m ~y ® *#define ° d ONLN d ™m ¥y )6targetFileFlags ° d ONLN d ƒm‘y⁄ (v‘\ ° d ONLN d »x ¢Ñ à (Å ¢boolean ° d ONLN d —x Íѧ )H noSearchForFile, SearchForFile; ° d ONLN d Ûx‘Ñ⁄ )Í\ ° d ONLN d ˜É ¢è à (å ¢boolean ° d ONLN d
É Íè¬ )H$TypeCrNeedNotMatch, TypeCrMustMatch; ° d ONLN d
%É‘è⁄ )Í\ ° d ONLN d
)é ¢ö Í (ó ¢ fill bit[14] ° d ONLN d
;éVöò )¥ /* Reserved ° d ONLN d
Géûö™ )H*/ ° d ONLN d
J§ ~∞ ñ (≠ ~type ° d ONLN d
O§ ¢∞ “ )$'intf' { ° d ONLN d
YØ êª ¿ (∏ êswitch { ° d ONLN d
d∫ ¢Δ +
case format0: ° d ONLN d
u≈ ¥— + key integer = 0; ° d ONLN d
à≈D—( )ê&/* Target File Spec. Format version */ ° d ONLN d
≤– ¥‹ (Ÿ ¥fileSpecFlags; ° d ONLN d
ƒ–D‹Ú )ê /* Target File Spec. Flags */ ˇ d ˇ ˇˇˇˇ d
° d ONLN d Q ¥ ] ( Z ¥literal longint; ° d ONLN d QD ]» )ê/* Target File Type */ ° d ONLN d - \ ¥ h ( e ¥literal longint; ° d ONLN d @ \D h⁄ )ê/* Target File Creator */ ° d ONLN d ] g ¥ s ( p ¥literal integer; ° d ONLN d p gD s‡ )ê/* Search Proc. Rsrc ID */ ° d ONLN d è r ¥ ~ ( { ¥evenPaddedString; ° d ONLN d £ rD ~» )ê/* Target File Path */ ° d ONLN d º } ¢ â ( Ü ¢
case format1: ° d ONLN d Õ à ¥ î + key integer = 1; ° d ONLN d ‡ àD î( )ê&/* Target File Spec. Format version */ ° d ONLN d
° d ONLN d• ~!, * noSearchForFile/SearchForFile ° d ONLN d√ ,. +ê @Determines if the Search Procedure code resource will be called. ° d ONLN d,83 * Use the ° d ONLN d
,38Å )%
searchForFile ° d ONLN d,Å8 )N$ flag to override the specified file ° d ONLN d?8D (A7path and use the list of files returned from the Search ° d ONLN dwDPy * Procedure code resource. ° d ONLN dêX ~dJ (a ~"TypeCrNeedNotMatch/TypeCrMustMatch ° d ONLN d≥co +ê ;Determines if the specified type and creator must match the ° d ONLN dÔo{ * >file found on the target disk. If the type and creator of the ° d ONLN d.{á$ * ?found file do not match those specified, the installation stops ° d ONLN dnáì+ * Cthe installation. This is also true of any found files returned by ° d ONLN d≤ìüq * the Search Procedure.
˚* * If the ° d ONLN d˚*Ñ ) TypeCrMustMatch ° d ONLN d ˚Ñ )Z% flag is used and an existing file is ° d ONLN dF$ (@found, its creator must match the creator entered in this field. ° d ONLN dà 7 * (4-bytes) ° d ONLN dí' ~3 ˆ (0 ~Target Finder Flags ° d ONLN dß'3$ )êAThe Finder flags to be given to a new file. If referenced from a ° d ONLN dÈ3?* * ?ResMerge Atom, the Finder Flags are given to the existing file. ° d ONLN d*?K* * >The Finder flags specified in a File Atom always override this ° d ONLN diKW÷ * .field. Only available in format 1. (2-bytes) ° d ONLN dò_ ~k ¸ (h ~Target Creation Date ° d ONLN dÆ_k) )êBThe creation date to be given to a new file. If referenced from a ° d ONLN dÚkw * ;File Atom or ResMerge Atom, the existing file is given this ° d ONLN d.wÉ- * Dcreation date. Leave as 0 to use the source file’s or today’s date. ° d ONLN dtÉè * ;Set to 1 to have ScriptCheck update using the source file’s ° d ONLN d∞èõ˝ * 7creation date. Only available in format 1. (4-bytes) ° d ONLN dË£ ~Ø ‰ (¨ ~Target Mod. Date ° d ONLN d˙£Ø )ê?The modification date to be given to a new file. If referenced ° d ONLN d :ت$ * >from a File Atom or ResMerge Atom, the existing file is given ° d ONLN d yª« * ?this modification date. Leave as 0 to use the source file’s or ° d ONLN d π«” * <today’s date. Set to 1 to have ScriptCheck update using the ˇ‡ d ˇ ˇˇˇˇ d
° d ONLN d Q ]* ( ZBsource file’s modification date. Only available in format 1. (4 ° d ONLN d B Q* ]. ( Z*- ° d ONLN d C ] i* ( fbytes) ,
Courier ° d ONLN d J q ~ } ( z ~Search Procedure Rsrc ID ° d ONLN d d | à# +ê ?The resource ID of an ‘insp’ resource, which describes the code ° d ONLN d § à î * >resource to call to perform the target file search. (2-bytes) ° d ONLN d „ ú ~ ® fi ( • ~Target File Path ° d ONLN d Û ú fi ® ‡ )` ° d ONLN d ı ú ®+ )0@The partial path to the target file that must start with a colon ° d ONLN d6 ® ¥ * <or one of two reserved tokens (special-xxxx or folder-user). ° d ONLN dt ¥ ¿é * (even-padded Pascal string)
° d ONLN d≥ Á ~ Û] +H4The ‘infs’ script resource is referenced from atoms. ° d ONLN dË ~ ® *#define ° d ONLN d ¥ )6
fileSpecFlags ° d ONLN d
ÊÏ ( Ê\ ° d ONLN d
¢ Ã ( ¢boolean ° d ONLN d
ͧ )H noSearchForFile, searchForFile; ° d ONLN d:
ÊÏ )¸\ ° d ONLN d> ¢$ Ã (! ¢boolean ° d ONLN dG Í$¬ )H$typeCrNeedNotMatch, typeCrMustMatch; ° d ONLN dmÊ$Ï )¸\ ° d ONLN dq# ¢/ Í (, ¢ fill bit[14] ° d ONLN d~9 ~E ñ (B ~type ° d ONLN dÉ9 ¢E “ )$'infs' { ° d ONLN dúD ¢P * literal longint; ° d ONLN dµDûPÊ )¸ /* File Type ° d ONLN d¬D¯P )Z*/ ° d ONLN d«O ¢[ (X ¢literal longint; ° d ONLN d‡Oû[¯ )¸/* File Creator ° d ONLN dO
[ )l*/ ° d ONLN dıZ ¢f (c ¢unsigned hex longint; ° d ONLN dZûf
)¸/* Creation Date*/ ° d ONLN d'e ¢q ˆ (n ¢fileSpecFlags; ° d ONLN d?eûq )¸/* File Spec Flags */ ° d ONLN dWp ¢| (y ¢evenPaddedString; ° d ONLN dqpû|¯ )¸/* Full Path */ ° d ONLN dÅ{ ~á ä (Ñ ~};
° d ONLN dÑó ~¢ ⁄ *Flags descriptions
° d ONLN dò• ~±, * noSearchForFile/searchForFile ° d ONLN d∑∞ºw +ê Ignored in Installer 4.0. ° d ONLN d—ƒ ~–J (Õ ~"typeCrNeedNotMatch/typeCrMustMatch ° d ONLN dıœ€
+ê 8Determines if the type and creator contained in the File ° d ONLN d.€Á+ * ?Creator and File Type fields must exactly match the source file ° d ONLN dnÁÛâ * on the source disk. Use the ° d ONLN dãÁâÛ„ ){typeCrMustMatch ° d ONLN döÁ„Û- )Z flag to force the ° d ONLN d≠Ûˇ (¸;type and creator to match, otherwise the installation stops ° d ONLN dÈˇ M * with an error.
° d ONLN d¯ ~ ◊ ( ~Field descriptions
° d ONLN d # ~/ fi *Source File Type ° d ONLN d # fi/ ‡ )` ° d ONLN d #/ë )0 The source file’s type. If the ° d ONLN d>#ë/Î )ÉTypeCrMustMatch ° d ONLN dM#Î/ )Z
flag is used ° d ONLN d[/;+ (8Athe source file’s type must match the type entered in this field. ° d ONLN dû;G * :Otherwise, the user is told the source disk is bad and the ° d ONLN dŸGS® * $installation is canceled. (4-bytes) ° d ONLN d˛[ ~g ˆ (d ~Source File Creator ° d ONLN d[gú )ê#The source file’s creator. If the ° d ONLN d6[úgˆ )éTypeCrMustMatch ° d ONLN dE[ˆg+ )Z
flag is used ° d ONLN dSgs (p<source file’s creator must match the creator entered in this ° d ONLN dês, * Bfield. Otherwise, the user is told the source disk is bad and the ° d ONLN d”㶠* #installation is canceled. (4-bytes) ° d ONLN d˜ì ~ü à (ú ~
Creation Date ° d ONLN dì Ãü Œ )N ° d ONLN dìü )B:The creation date the source file must have, otherwise the ° d ONLN dAü´- * Binstallation is stopped. Values of 0 or 1 are considered to match ° d ONLN dÑ´∑ç * any creation date. (4-bytes) ° d ONLN d¢ø ~À fi (» ~Source File Path ° d ONLN d≤ø fiÀ ‡ )` ° d ONLN d¥øÀ )0>The full path to the source file. (even-padded Pascal string) ˇ d ˇ ˇˇˇˇ d
° d ONLN d Q 6 e ( ` 6 About File Searching (‘insp’) " ° ∂ e 4 e0 ° ∂ ° ∂
° d ONLN d j ~ v! +H]Whenever you want to update or delete a file on the user’s disk but don’t know where the file ° d ONLN d | v ~ Ç& * bwill reside, you’ll need to search for it at installation time. For those File and Resource atoms ° d ONLN d fl Ç ~ é" * ayou wish to search for the target file, attach a Search Procedure (‘insp’) script resource to the ° d ONLN dA é ~ ö+ * enew Target File Spec. (‘intf’) script resource, then reference the ‘intf’ resource from the atom just ° d ONLN dß ö ~ ¶{ * <as you would the older ‘infs’ script resource. Setting the ,
Courier ° d ONLN d„ ö{ ¶… )˝
searchForFile ° d ONLN d ö… ¶ )N flag in the ‘intf’ ° d ONLN d ¶ ~ ≤! ( Ø ~aresource will tell the Installer to call the code resource at the appropriate time. The built-in ° d ONLN df ≤ ~ æÜ * ;searching feature of the Installer will be removed and the ° d ONLN d° ≤Ü æ‘ ( ªÜ
searchForFile ° d ONLN dÆ ≤‘ æ) )N flag in the present ° d ONLN d√ æ ~ ( « ~ ‘infs’ resource will be ignored. ° d ONLN d “ ~ fi *]The actual searching code will be supplied by you, the scriptwriter, in a code resource whose ° d ONLN dC fi ~ ÍK * 0type and ID is specified in the ‘insp’ resource.
° d ONLN dt ˛ ~
ª *"1Using File Searching with File and Resource Atoms " ° ∂ | 0 ° ∂ ° ∂
° d ONLN d¶ ~
*ZThe file searching code resource is given a pointer to a parameter block containing useful ° d ONLN d ~) * \information about the Installer’s environment. The search routine performs a search for the ° d ONLN d^) ~5% * edesired file(s), then passes back a list of those files it has found, including a result code to tell ° d ONLN dƒ5 ~A7 * *the Installer whether to continue or stop. ° d ONLN dÔI ~U) *aThe search routine’s task is to create and return a handle to an array of FoundFileRec records in ° d ONLN dQU ~a „ * the parameter block’s ° d ONLN dgU „a% )e fFoundFiles ° d ONLN drU%aÔ )B. field. The array should contain zero or more ° d ONLN d°a ~m (j ~^FoundFileRec records that specify each target file to act upon. The number of elements in the ° d ONLN d m ~y * ^array is determined by the size of the handle. If the array has no elements, then the atom is ° d ONLN d_y ~Ö, * dignored. If one FoundFileRec element is specified, then the atom (file, resource, or font atom ) is ° d ONLN dƒÖ ~ë% * ]processed normally with the designated target file. If more than one FoundFileRec element is ° d ONLN d"ë ~ùq * 6in the array, the atom is duplicated for each element. ° d ONLN dZ• ~± *^The files that are returned to the Installer may or may not already exist. The Installer will ° d ONLN dπ± ~Ω * Yverify that the volume and directory exist and are valid, and that the file name does not ° d ONLN dΩ ~…( * dconflict with an existing directory name. If the file does not exist the Installer will create one, ° d ONLN dx… ~’ ∂ *
° d ONLN d≠¸ ~- *cFile searching can also be used with Target File Specs that are referenced from rule clauses. If a ° d ONLN d ~ * _Target File Spec returns more than one found file, the rule clause is duplicated for each valid ° d ONLN d q ~ + * bfile. The duplicated rule clauses are “anded” with the original rule clause. Therefore, in order ° d ONLN d ‘ ~,) * `for the original rule clause to return TRUE, every duplicated rule clause must also return TRUE.
° d ONLN d
5@ ~O∫ *"3Allowable Installer Functions During File Searching " ° ∂ N |N0 ° ∂ ° ∂
° d ONLN d
iS ~_ *`While your file searching code resource is executing, you can call selected Installer functions. ° d ONLN d
° d ONLN d Q 6 e ( ` 6File Searching Reference " ° ∂ e 4 e0 ° ∂ ° ∂
° d ONLN d j ~ v% +HaThis section describes the data structures and new script resources needed to support target file ° d ONLN d { v ~ Ç ≠ *
searching.
° d ONLN d Ü ñ 6 ¶ ú ( ¢ 6Data Structures " ° ∂ ¶ 4 ¶0 ° ∂ ° ∂
° d ONLN d ñ ´ ~ ∑ +HVThis section describes the function interface and parameter block passed to the Search ° d ONLN d Ì ∑ ~ √ È * Procedure code resource. ° d ONLN d À ~ ◊! *_The Search Procedure must return a handle to an array of records describing the files it found. ° d ONLN dg ◊ ~ „ * This array handle is defined as: ,
Courier ° d ONLN dà Á ~ Û fi *typedef struct { ° d ONLN dô Ú ~ ˛ ¥ * short ° d ONLN d£ Ú Δ ˛ ˆ )HvRefNum; ° d ONLN d¨ ˝ ~ Æ ( ~ long ° d ONLN d∂ ˝ Δ Í )HparID; ° d ONLN dΩ ~ ¥ ( ~ Str63 ° d ONLN d« Δ ‰ )Hname; ° d ONLN dŒ ê Æ ( êshort ° d ONLN d’ Δ )6
fReferenceID; ° d ONLN d‰2 Ú )l /* Reserved for internal use. */ ° d ONLN d ~*» (' ~7} FoundFileRec, FoundFileArray[], *FoundFileArrayPtr[], ° d ONLN d=) ~5 ‰ * **FoundFileHdl[]; ° d ONLN dOC ~Ol *5The handle should be allocated using the Installer’s ° d ONLN dÑClO® )Ó
° d ONLN d´v ~Ç +H^This section describes the Search Procedure function interface and the required result values. ° d ONLN d
ï ~° * _The file search function must return one of three results to tell the Installer how to proceed: ° d ONLN dj• ~±D *!typedef enum { kFatalSearchError ° d ONLN dè•å±™ (Æå= -1, ° d ONLN dö∞ ÿºD (π ÿkSearchSuccessful ° d ONLN d∞∞座 )¥= 0, ° d ONLN d∫ª ÿ«Ä (ƒ ÿ kCancelSearchAndInstallation ° d ONLN d◊ªå«û )¥= 1 ° d ONLN dflΔ Δ“ (œ Δ} SearchResult; ° d ONLN dÔ‡ ~Ïà (È ~;The file search function must have the following interface: ° d ONLN d+ ~¸ Δ * SearchResult ° d ONLN d8 ÿ¸Œ )Z)FileSearchRoutine( SearchProcedurePBPtr);
° d ONLN db 6 ë ( 6Parameter Block " ° ∂ 40 ° ∂ ° ∂
° d ONLN dr ~* +HXThe file search code resource is passed a pointer to a parameter block containing useful ° d ONLN dÀ* ~6
*File Specification (Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ó101 ° d ONLN d Q ~ \ ◊ ( Y ~Field descriptions ,
Courier
° d ONLN d _ ~ k fi *fCallBackProcPtr ° d ONLN d % _ k )ê>A pointer to the Installer’s dispatch routine. You’ll need to ° d ONLN d d k w * <pass this field as a parameter to glue routines that provide ° d ONLN d ° w Éã * access to Installer functions. ° d ONLN d ¿ ã ~ ó “ ( î ~fTargetVRefNum ° d ONLN d œ ã ó, )ê>The target disk’s vRefNum. When allowing the user to select a ° d ONLN d ó £ * :target application folder, this is the volume on which the ° d ONLN dI £ ØO * folder resides. ° d ONLN dY ∑ ~ √ Í ( ¿ ~fTargetFolderDirID ° d ONLN dl ∑ √, )êBThe target application folder’s directory ID. This value is -1 if ° d ONLN dØ √ œ# * @the user cannot select a target application folder. Target File ° d ONLN d œ €¬ * (Specs that use the reserved folder path ° d ONLN d œ¬ € )¥ folder-user ° d ONLN d# œ €& )B will be ° d ONLN d, € Án ( ‰placed in this folder. ° d ONLN dC Ô ~ ˚ “ ( ¯ ~fSystemVRefNum ° d ONLN dR Ô ˚ )ê:The system disk’s vRefNum. Target File Specs that use the ° d ONLN dç ˚n * reserved folder path ° d ONLN d¢ ˚n∞ )` special-xxx ° d ONLN d≠ ˚∞ )B will be placed in the ° d ONLN dƒñ ( System Folder on this volume. ° d ONLN d‚ ~' ($ ~fSystemBlessedDirID ° d ONLN dˆ' )ê:The directory ID of the System Folder on the disk with the ° d ONLN d1'33 * refNum ° d ONLN d8'33á )%fSystemVRefNum ° d ONLN dF'á3 )T$. This directory is not necessarily ° d ONLN dk3?Æ (<#the currently active System Folder. ° d ONLN dèG ~S ® (P ~fRefCon ° d ONLN dóGS" )ê?A 4-byte value defined by the scriptwriter in the ‘insp’ script ° d ONLN d◊S_5 * resource. ° d ONLN d·g ~s à (p ~
fFileSpecType ° d ONLN dÔgs )ê<The value from the Target File Type field of the Target File ° d ONLN d,s& * Spec. ° d ONLN d2á ~ì fi (ê ~fFileSpecCreator ° d ONLN dCáì* )ê?The value from the Target File Creator field of the Target File ° d ONLN dÉìü& * Spec. ° d ONLN dâß ~≥ ÿ (∞ ~fFileSpecCrDate ° d ONLN dôß≥ )ê9The value from the Target File Creation Date field of the ° d ONLN d”≥ø[ * Target File Spec. ° d ONLN d« ~” à (– ~
fFileSpecPath ° d ONLN dÛ«” )ê<The value from the Target File Path field of the Target File ° d ONLN d0”fl& * Spec. ° d ONLN d6Á ~Û fi ( ~fFoundFilesArray ° d ONLN dGÁÛ )ê>A handle to an array of found target files that is created and ° d ONLN dÜÛˇá * filled by the code resource.
° d ONLN d∏( ~4* +HcThe ‘insp’ script resource is referenced from the new Target File Spec. It defines how to call the ° d ONLN d 4 ~@_ * 2code resource that will perform the actual search. ° d ONLN dOO ~[ ñ *type ° d ONLN dTO ¢[ “ )$'insp' { ° d ONLN d_Z êf ¿ (c êswitch { ° d ONLN dje ¢q +
case format0: ° d ONLN d{p ¥| + key integer = 0; ° d ONLN dåp |˛ )l%/* Search Procedure Format version */ ° d ONLN dµ{ ¥á (Ñ ¥unsigned integer; ° d ONLN d«{ á» )l /* Search Procedure Flags */ ° d ONLN dÁÜ ¥í (è ¥literal longint; ° d ONLN d¯Ü í˛ )l%/* Search Procedure Code Rsrc Type */ ° d ONLN d!ë ¥ù (ö ¥literal integer; ° d ONLN d2ë ùÚ )l#/* Search Procedure Code Rsrc ID */ ° d ONLN dYú ¥® (• ¥literal longint; ° d ONLN djú ®å )l/* RefCon Value */ ° d ONLN dÄß ¥≥ (∞ ¥literal longint; ° d ONLN dëß ≥º )l/* Required Free Memory */ ° d ONLN dØ≤ ¥æ (ª ¥evenPaddedString; ° d ONLN d¡≤ æ‘ )l /* Search Procedure Summary */ ° d ONLN d‡Ω ~… ä (Δ ~}; ° d ONLN d„» ~‘ ä * }; ˇ“ d ˇ ˇˇˇˇ d
d , Palatino
. +~3C H A P T E R 5 , Helvetica
*File Specification (Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ó102 ° d ONLN d Q ~ \ ◊ ( Y ~Field descriptions ,
* :resource needs in its own heap to make local allocation of ° d ONLN de
) * >memory using Macintosh OS/Toolbox routines. Enter 0 (zero) to ° d ONLN d§% * :not create a sub-heap and run inside the Installer’s heap. ° d ONLN d‡%1 * 6Please see warnings about using sub-heaps in the Atom ° d ONLN d1=$ * @Extender section if you specify a value other than 0. (4-bytes) ° d ONLN dYE ~Q fi (N ~Search Procedure ° d ONLN diE fiQ ‡ )` ° d ONLN djE ‡Q
)Summary ° d ONLN drP\+ +. @An optional string briefly describing the purpose of this Search ° d ONLN d≥\h * >Procedure. This string is never displayed to the user. (even ° d ONLN dÒ\h (e- ° d ONLN dÚhtq (qpadded Pascal string)
° d ONLN d å 6†z (õ 6&About the Disk Order Resource (‘indo’) " ° ∂ † 4†0 ° ∂ ° ∂
° d ONLN d0• ~±! +H`By default, the Installer requests disks from the user using the order of the atoms specified in ° d ONLN dë± ~Ω* * bthe script. This ordering is displayed in the status dialog. With more than just a few atoms, it ° d ONLN dÙΩ ~… * _can be very difficult to control the order of disks. To make this easier, if an Installer Disk ° d ONLN dT… ~’W * 3Order resource exists in the script (resource type ° d ONLN dá…W’{ )Ÿ'indo' ° d ONLN dç…{’* )$)), this resource is used to determine the ° d ONLN d∑’ ~·4 (fi ~*ordering of the disks. The format of the ° d ONLN d·’4·X )∂'indo' ° d ONLN dÁ’X·. )$2 resource is given below. The resource contains a ° d ONLN d· ~Ì (Í ~^list of Pascal strings that are the names of the source disks. These names must exactly match ° d ONLN dyÌ ~˘˙ * Tthe names of the volumes given in the source and target paths within the File Specs. ° d ONLN dœ ~
*[For example, let’s say you have created a two disk set that uses one floppy disk and one CD ° d ONLN d+
~8 * *volume. Your ‘indo’ might look like this: ° d ONLN dV ~) *resource 'indo' (1000) { ° d ONLN dp( ê4 Ã +
format1 {{ ° d ONLN d}3 ¢? + kExpectFloppyDisk, ° d ONLN dí> ¢J * "Installer Disk", ° d ONLN d¶I ¢U * kExpectCDVolume, ° d ONLN dπT ¢` * "Applications CD" ° d ONLN dÃ_ êk ¢ (h ê}}; ° d ONLN d–j ~v ä (s ~}; ° d ONLN d”Ñ ~ê *\Specifying the expected type of source disk just helps the Installer know which type of disk ° d ONLN d0ê ~ú * ^drive to make available to insert the requested source disk. This feature does not affect the ° d ONLN dèú ~®˝ * Uuser’s ability to create network installation folders on an AppleShare server volume. ˇ
° d ONLN d v 6 Ü Ω *"Resource Description " ° ∂ e 4 e0 ° ∂ ° ∂ " ° ∂ Ü 4 Ü0 ° ∂ ° ∂
° d ONLN d * ã ~ ó +H$Format 0 of the new ‘indo’ resource: ,
Courier ° d ONLN d O õ ~ ß *#define SrcDiskType ° d ONLN d p õÊ ßÏ ( §Ê\ ° d ONLN d t ¶ ¢ ≤ à ( Ø ¢integer ° d ONLN d ã ¶Ê ≤Ï ( ØÊ\ ° d ONLN d è ± ¢ Ω ( ∫ ¢kExpectFloppyDisk ° d ONLN d ¢ ± Ω8 )~= 0, ° d ONLN d ß ±D Ω‘ )$/* It’s a floppy Disk */ ° d ONLN d ¿ ±Ê ΩÏ )¢\ ° d ONLN d ƒ º ¢ » ( ≈ ¢kExpectCDVolume ° d ONLN d ÷ º »8 )~= 1, ° d ONLN d € ºD »û )$/* It’s a CD */ ° d ONLN d Ó ºÊ »Ï )¢\ ° d ONLN d Ú « ¢ ” ( – ¢kExpectFoldersOnVol ° d ONLN d « ”2 )~= 2 ° d ONLN d «D ”∂ )$/* It’s a folder */ ° d ONLN d › ~ È Ã ( Ê ~
type 'indo' { ° d ONLN d/ Ë ê Ù ¿ + switch { ° d ONLN d: Û ¢ ˇ +
case format1: ° d ONLN dK ˛ ¥
+ key integer = 1; ° d ONLN d_ ¥z * !integer = $$Countof(SrcVolArray); ° d ONLN dÑ ¥ & * array SrcVolArray { ° d ONLN dù ÿ+ +$ SrcDiskType; ° d ONLN d¨ V+⁄ )~/* Source Disk Type */ ° d ONLN d»* ÿ6> (3 ÿevenPaddedString; ° d ONLN d€*V6⁄ )~/* Source Disk Name */ ° d ONLN dı5 ¥A ¿ (> ¥}; ° d ONLN d˘@ êL ú (I ê}; ° d ONLN d¸K ~W ä (T ~};
° d ONLN dˇg ~r ◊ *Field descriptions
° d ONLN du ~Å fi *Source Disk Type ° d ONLN d"u fiÅ ‡ )` ° d ONLN d$uÅ( )0?The expected source disk type. Currently, a floppy disk; CD or ° d ONLN ddÅç * 9folders on a CD, HD, or AppleShare volume. The Installer ° d ONLN dûçô * :primarily uses this information to determine which type of ° d ONLN dŸô• * >disk to eject to make room for the requested source disk. For ° d ONLN d•±+ * @example, if the requested source disk is expected to be a CD and ° d ONLN dY±Ω * @all CD drives are full, then one of the CDs will be ejected. (2 ° d ONLN dô± Ω$ (∫ - ° d ONLN döΩ…* (Δbytes) ° d ONLN d¢— ~› fi (⁄ ~Source Disk Name ° d ONLN d≤— fi› ‡ )` ° d ONLN d¥—›( )0@The name of the source disk. The name can end in a colon if you ° d ONLN dı›ÈU * wish. (2-bytes) ˇ J d ˇ ˇˇˇˇ d
d , Palatino
. +~-C H A P T E R 6 , Helvetica
(Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ó104
$ ° d ONLN d Q ~ y• ( o ~Installer Functions " ° ∂ 40 ° ∂ ° ∂
° d ONLN d ~* *∏WThis chapter describes the routines that are available when running as an external code ° d ONLN d l* ~6= * *resource within the Installer environment.
° d ONLN d óN 6b (] 6About Installer Functions " ° ∂ b 4b0 ° ∂ ° ∂
° d ONLN d ±g ~s +H\Installer functions allow the code resource writer to communicate with the Installer and use ° d ONLN ds ~, * autility routines provided by the Installer. Some of the routines are the essential mechanism for ° d ONLN dp ~ã* * ^communicating with the Installer, such as when decompressing files during installation. These ° d ONLN dœã ~ó * _routines are often limited to being called from specific code resources. Other routines may be ° d ONLN d/ó ~£- * aavailable all the time, either as a means to getting information from the Installer or as helpful ° d ONLN dë£ ~Ø Δ * utility routines. ° d ONLN d£∑ ~√% *aAll Installer callback functions are actually glue routines that you must include in your code to ° d ONLN d√ ~œ* * caccess the proper routines inside the Installer. In the discussion of each routine the name of the ° d ONLN diœ ~€+ * 'header file and glue file is mentioned.
° d ONLN d£ ~, +H_This section describes the routines available to manage reading and writing atom data. Most of ° d ONLN d ~ * ]these routines are only available in Atom Extenders. These routines function very similar to ° d ONLN da ~&A * +high-level File Manager routines. Consult ° d ONLN dåA&´ )√Inside Macintosh: File ° d ONLN d§´& )js for an overview of topics ° d ONLN d¿& ~2 (/ ~#such as positioning marks in files.
° d ONLN d‰J 6X ë (T 6ReadSourceData " ° ∂ X 4X0 ° ∂ ° ∂ ,
Courier
° d ONLN dÛm ~y +H"OSErr ReadSourceData( ° d ONLN d
*Installer Functions (Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ó105 ° d ONLN d Q 6 Z s ( X 6 DESCRIPTION
° d ONLN d ` ~ l í +HThe ,
Courier ° d ONLN d ` í l Ê )ReadSourceData ° d ONLN d ` Ê l
)TB function reads the specified number of bytes from the source data ° d ONLN d a l ~ x( ( u ~_beginning at the current position. The supplied pointer must have already been allocated to at ° d ONLN d ¡ x ~ Ñ » * least the size of ° d ONLN d ” x » Ñ Ê )Jcount ° d ONLN d ÿ x Ê Ñ È ) . ° d ONLN d ⁄ é ~ ö ( ó ~TSee interface file “AtomExtenderHeader.h” and glue code file “AtomExtenderCBGlue.c”.
° d ONLN d/ ¶ 6 Ø { ( ≠ 6 RESULT CODES
° d ONLN d= Ø ~ ª Í +H kNotImplementedErr ° d ONLN dP Ø ı ª )w30901 ° d ONLN dV Ø ªº )+!Routine not currently implemented ° d ONLN dx ª ~ « ú ( ƒ ~noErr ° d ONLN d~ ª « )ã0 ° d ONLN dÄ ª «F )No error ° d ONLN dâ « ~ ” ú ( – ~ioErr ° d ONLN dè « ” )Ç-36 ° d ONLN dì « ”J ) I/O Error ° d ONLN dù ” ~ fl ¢ ( ‹ ~eofErr ° d ONLN d§ ” fl )Ç-39 ° d ONLN d® ” fly ) End of part reached ° d ONLN dº fl ~ Î Æ ( Ë ~paramErr ° d ONLN d≈ fl Î )Ç-50 ° d ONLN d… fl Î∫ ) Negative count or NULL bufferPtr
° d ONLN dÍ ˇ 6
ì ( 6WriteTargetData " ° ∂
4
0 ° ∂ ° ∂
° d ONLN d˙" ~. +H"OSErr WriteTargetData( ° d ONLN d".h )êCallBackProcPtr ° d ONLN d""z.‡ )lpCallBackProcPtr, ° d ONLN d<-9, (6long ° d ONLN dF-z9û )lcount, ° d ONLN dU8D& (APtr ° d ONLN d^8zD¬ )l bufferPtr ); ° d ONLN dkR ~^ — ([ ~pCallBackProcPtr ° d ONLN d|R^o )êThe callback pointer. ° d ONLN díf ~r ú (o ~count ° d ONLN dòfr )ê9The number of bytes to write to the target at the current ° d ONLN d“r~6 * position. ° d ONLN d‹Ü ~í ¥ (è ~ bufferPtr ° d ONLN dÂÜ ¥í ∂ )6 ° d ONLN dÁÜíØ )Z'A pointer to a buffer of at least size ° d ONLN dÜØíÕ )°count ° d ONLN dÜÕí– ) .
° d ONLN dû 6ß s (• 6 DESCRIPTION
° d ONLN d!≠ ~π í +HThe ° d ONLN d%≠ íπ Ï )WriteTargetData ° d ONLN d4≠ Ïπ& )ZG function writes the specified number of bytes from the supplied buffer ° d ONLN d|π ~≈ (¬ ~\to the target beginning at the current position. The data is not immediately written to the ° d ONLN dŸ≈ ~—! * ]target file, but rather is buffered using the Installer heap or MultiFinder temporary memory. ° d ONLN d8— ~› * ]This reduces our need for the target disk, which is especially important when installing onto ° d ONLN dñ› ~È ∫ *
floppy disks.
° d ONLN d§ı 6˛ n (¸ 6 IMPORTANT
° d ONLN dÆ ~m +H5Since there is overhead associated with each call to ° d ONLN d„m« )ÔWriteTargetData ° d ONLN dÚ« )Z, calls to write very ° d ONLN d ~ | ( ~7small amounts of data (less than 1K) should be avoided. ° d ONLN dA& ~2 *TSee interface file “AtomExtenderHeader.h” and glue code file “AtomExtenderCBGlue.c”.
° d ONLN dñ> 6G { (E 6 RESULT CODES
° d ONLN d£G ~S Í +H kNotImplementedErr ° d ONLN d∂G ıS )w30901 ° d ONLN dºG Sº )+!Routine not currently implemented ° d ONLN dfiS ~_ ú (\ ~noErr ° d ONLN d‰S _ )ã0 ° d ONLN dÊS _F )No error ° d ONLN dÔ_ ~k Æ (h ~paramErr ° d ONLN d¯_ k )Ç-50 ° d ONLN d¸_ k∫ ) Negative count or NULL bufferPtr ° d ONLN d k ~w ∫ (t ~
memFullErr ° d ONLN d)k ˚w )}-108 ° d ONLN d.k w∫ )% Not enough memory to buffer data
° d ONLN dOã 6ô é (ï 6ReadTargetData " ° ∂ ô 4ô0 ° ∂ ° ∂
° d ONLN d^Æ ~∫ +H"OSErr ReadTargetData( ° d ONLN duÆ∫h )êCallBackProcPtr ° d ONLN dÖÆz∫‡ )lpCallBackProcPtr, ° d ONLN d†π≈2 (¬long* ° d ONLN d™πz≈û )lcount, ° d ONLN dπƒ–& (ÕPtr ° d ONLN d¬ƒz–¬ )l bufferPtr ); ˇfi d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ] — ( Z ~pCallBackProcPtr ° d ONLN d Q ]o )êThe callback pointer. ,
Courier ° d ONLN d ' e ~ q ú ( n ~count ° d ONLN d - e q )ê<The number of bytes to read from the target data. After the ° d ONLN d j q }Ò * 5call, the actual number of bytes read is returned in ° d ONLN d ü qÒ } )„count ° d ONLN d § q } ) . ° d ONLN d ¶ Ö ~ ë ¥ ( é ~ bufferPtr ° d ONLN d Ø Ö ¥ ë ∂ )6 ° d ONLN d ± Ö ëØ )Z'A pointer to a buffer of at least size
° d ONLN d ÿ ÜØ ë» )°count
° d ONLN d › Ö» ëÀ ).
° d ONLN d fl ù 6 ¶ s ( § 6 DESCRIPTION
° d ONLN d Î ¨ ~ ∏ í +HThe ° d ONLN d Ô ¨ í ∏ ™ )Read ° d ONLN d Û ¨ ™ ∏ » )Target ° d ONLN d ˘ ¨ » ∏ ‡ ) Data ° d ONLN d ˝ ¨ ‡ ∏ )B function reads the specified number of bytes from the target data ° d ONLN d@ ∏ ~ ƒ( ( ¡ ~_beginning at the current position. The supplied pointer must have already been allocated to at ° d ONLN d† ƒ ~ – » * least the size of ° d ONLN d≤ ƒ » – Ê )Jcount ° d ONLN d∑ ƒ Ê – È ) .
° d ONLN dπ ‹ 6 Â n ( „ 6 IMPORTANT
° d ONLN d√ È ~ ı í +HThe ° d ONLN d« È í ı ™ )Read ° d ONLN dÀ È ™ ı » )Target ° d ONLN d— È » ı ‡ ) Data ° d ONLN d’ È ‡ ı, )J function can only be called while in a Version Compare code resource that ° d ONLN d ı ~ ( ˛ ~[was referenced from a Resource Atom. Calling this function at any other time will return a ° d ONLN d| ~
Í * kNotImplementedErr ° d ONLN dé Í
)l error. ° d ONLN dñ ~# ( ~TSee interface file “AtomExtenderHeader.h” and glue code file “AtomExtenderCBGlue.c”.
° d ONLN dÎ/ 68 { (6 6 RESULT CODES
° d ONLN d˘8 ~D Í +H kNotImplementedErr ° d ONLN d 8 ıD )w30901 ° d ONLN d8 Dº )+!Routine not currently implemented ° d ONLN d4D ~P ú (M ~noErr ° d ONLN d:D P )ã0 ° d ONLN d<D PF )No error ° d ONLN dEP ~\ ú (Y ~ioErr ° d ONLN dKP \ )Ç-36 ° d ONLN dOP \J ) I/O Error ° d ONLN dY\ ~h ¢ (e ~eofErr ° d ONLN d`\ h )Ç-39 ° d ONLN dd\ hy ) End of part reached ° d ONLN dxh ~t Æ (q ~paramErr ° d ONLN dÅh t )Ç-50 ° d ONLN dÖh t∫ ) Negative count or NULL bufferPtr
° d ONLN d∏´ ~∑ +H"OSErr SetTargetDataPos( ° d ONLN d–´∑h )êCallBackProcPtr ° d ONLN d‡´z∑‡ )lpCallBackProcPtr, ° d ONLN d˙∂¬2 (øshort ° d ONLN d∂z¬» )l
positionMode, ° d ONLN d¡Õ, ( long ° d ONLN d$¡zÕ‡ )lpositionOffset ); ° d ONLN d6– ~‹ — (Ÿ ~pCallBackProcPtr ° d ONLN dG–‹o )êThe callback pointer. ° d ONLN d]‰ ~ Δ (Ì ~ positionMode ° d ONLN dj‰r )êThe positioning mode. ° d ONLN dį ~ “ ( ~positionOffset ° d ONLN dé¯ “ ‘ )T ° d ONLN dê¯t )<The positioning offset.
° d ONLN d® 6 s ( 6 DESCRIPTION
° d ONLN d¥ ~+ í +HThe ° d ONLN d∏ í+ Ú )SetTargetDataPos ° d ONLN d» Ú+€ )`7 function sets the current position in the target data. ° d ONLN d5 ~A (> ~TSee interface file “AtomExtenderHeader.h” and glue code file “AtomExtenderCBGlue.c”.
° d ONLN dVM 6V { (T 6 RESULT CODES
° d ONLN dcV ~b Í +H kNotImplementedErr ° d ONLN dvV ıb )w30901 ° d ONLN d|V bº )+!Routine not currently implemented ° d ONLN dûb ~n ú (k ~noErr ° d ONLN d§b n )ã0 ° d ONLN d¶b nF )No error ° d ONLN dØn ~z ¢ (w ~eofErr ° d ONLN d∂n z )Ç-50 ° d ONLN d∫n zô ) End of target data reached ° d ONLN d’z ~Ü ¢ (É ~posErr ° d ONLN d‹z Ü )Ç-40 ° d ONLN d‡z Ü
) 4Attempt to position mark before start of target data
° d ONLN dö 6® ò (§ 6GetTargetDataPos " ° ∂ ® 4®0 ° ∂ ° ∂
° d ONLN d&Ω ~… +H"OSErr GetTargetDataPos( ° d ONLN d>Ω…h )êCallBackProcPtr ° d ONLN dNΩz…‡ )lpCallBackProcPtr, ° d ONLN di»‘, (—long* ° d ONLN ds»z‘‡ )lpositionOffset ); ˇ‰ d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ] — ( Z ~pCallBackProcPtr ° d ONLN d Q ]o )êThe callback pointer. ,
Courier ° d ONLN d ' e ~ q “ ( n ~positionOffset ° d ONLN d 5 e “ q ‘ )T ° d ONLN d 7 e q )<8On output, contains the current position offset from the ° d ONLN d p q }è * beginning of the target data.
° d ONLN d é â 6 í s ( ê 6 DESCRIPTION
° d ONLN d ö ò ~ § í +HThe ° d ONLN d û ò í § Ú )GetTargetDataPos ° d ONLN d Æ ò Ú §$ )`G function returns the current position from the beginning of the target ° d ONLN d ˆ § ~ ∞ ó ( ≠ ~data. ° d ONLN d ˝ ∫ ~ Δ *TSee interface file “AtomExtenderHeader.h” and glue code file “AtomExtenderCBGlue.c”.
° d ONLN dR “ 6 € { ( Ÿ 6 RESULT CODES
° d ONLN d_ € ~ Á ‡ +H kNotImplementedErr ° d ONLN dr € ı Á )w30901 ° d ONLN dx € Áº )+!Routine not currently implemented ° d ONLN dö Á ~ Û ú ( ~noErr ° d ONLN d† Á Û )ã0 ° d ONLN d¢ Á ÛF )No error
° d ONLN dº* ~6 +H"OSErr GetTargetDataEOF( ° d ONLN d‘*6h )êCallBackProcPtr ° d ONLN d‰*z6‡ )lpCallBackProcPtr, ° d ONLN dˇ5A, (>long* ° d ONLN d 5zA¬ )l theLength ); ° d ONLN dD ~P — (M ~pCallBackProcPtr ° d ONLN d'DPo )êThe callback pointer. ° d ONLN d=X ~d ¥ (a ~ theLength ° d ONLN dFX ¥d ∂ )6 ° d ONLN dHXd
)Z:On output, contains the current length of the target data.
° d ONLN dÉp 6y s (w 6 DESCRIPTION
° d ONLN dè ~ã í +HThe ° d ONLN dì íã Ú )GetTargetDataPos ° d ONLN d£ Úã‚ )`8 function returns the current length of the target data. ° d ONLN d‹ï ~° (û ~TSee interface file “AtomExtenderHeader.h” and glue code file “AtomExtenderCBGlue.c”.
° d ONLN d1≠ 6∂ { (¥ 6 RESULT CODES
° d ONLN d>∂ ~¬ Í +H kNotImplementedErr ° d ONLN dQ∂ ı¬ )w30901 ° d ONLN dW∂ ¬º )+!Routine not currently implemented ° d ONLN dy¬ ~Œ ú (À ~noErr ° d ONLN d¬ Œ )ã0 ° d ONLN dŬ ŒF )No error
° d ONLN dä‚ 6 ô (Ï 6SetSourceDataPos " ° ∂ 40 ° ∂ ° ∂
° d ONLN dõ ~ +H"OSErr SetSourceDataPos( ° d ONLN d≥h )êCallBackProcPtr ° d ONLN d√z‡ )lpCallBackProcPtr, ° d ONLN dfi 2 (short ° d ONLN dËz » )l
positionMode, ° d ONLN d˛', ($long ° d ONLN dz'‡ )lpositionOffset ); ° d ONLN d* ~6 — (3 ~pCallBackProcPtr ° d ONLN d+*6o )êThe callback pointer. ° d ONLN dA> ~J Δ (G ~ positionMode ° d ONLN dN>Jr )êThe positioning mode. ° d ONLN ddR ~^ “ ([ ~positionOffset ° d ONLN drR “^ ‘ )T ° d ONLN dtR^t )<The positioning offset.
° d ONLN dåj 6s s (q 6 DESCRIPTION
° d ONLN dòy ~Ö í +HThe ° d ONLN dúy íÖ Ú )SetSourceDataPos ° d ONLN d¨y ÚÖ⁄ )`7 function sets the current position in the source data. ° d ONLN dÂè ~õ (ò ~TSee interface file “AtomExtenderHeader.h” and glue code file “AtomExtenderCBGlue.c”.
° d ONLN d:ß 6∞ { (Æ 6 RESULT CODES
° d ONLN dG∞ ~º Í +H kNotImplementedErr ° d ONLN dZ∞ ıº )w30901 ° d ONLN d`∞ ºº )+!Routine not currently implemented ° d ONLN dǺ ~» ú (≈ ~noErr ° d ONLN dຠ» )ã0 ° d ONLN däº »F )No error ° d ONLN dì» ~‘ ¢ (— ~eofErr ° d ONLN dö» ‘ )Ç-50 ° d ONLN dû» ‘Æ ) End of source part data reached ° d ONLN dæ‘ ~‡ ¢ (› ~posErr ° d ONLN d≈‘ ‡ )Ç-40 ° d ONLN d…‘ ‡ ) 9Attempt to position mark before start of source part data ˇΔ d ˇ ˇˇˇˇ d
° d ONLN d t ~ Ä +H"OSErr GetSourceDataPos( ° d ONLN d ) t Äh )êCallBackProcPtr ° d ONLN d 9 tz ć )lpCallBackProcPtr, ° d ONLN d S ã2 ( àlong* ° d ONLN d ] z ㇠)lpositionOffset ); ° d ONLN d o é ~ ö — ( ó ~pCallBackProcPtr ° d ONLN d Ä é öo )êThe callback pointer. ° d ONLN d ñ ¢ ~ Æ “ ( ´ ~positionOffset ° d ONLN d § ¢ “ Æ ‘ )T ° d ONLN d ¶ ¢ Æ )<>On output, contains the current position from the beginning of ° d ONLN d Â Æ ∫V * the source data.
° d ONLN d ˆ Δ 6 œ s ( Õ 6 DESCRIPTION
° d ONLN d ’ ~ · í +HThe ° d ONLN d ’ í · Ú )GetSourceDataPos ° d ONLN d ’ Ú ·# )`G function returns the current position from the beginning of the source ° d ONLN d^ · ~ Ì ó ( Í ~data. ° d ONLN de ˜ ~ *TSee interface file “AtomExtenderHeader.h” and glue code file “AtomExtenderCBGlue.c”.
° d ONLN d∫ 6 { ( 6 RESULT CODES
° d ONLN d« ~$ Í +H kNotImplementedErr ° d ONLN d⁄ ı$ )w30901 ° d ONLN d‡ $º )+!Routine not currently implemented ° d ONLN d$ ~0 ú (- ~noErr ° d ONLN d$ 0 )ã0 ° d ONLN d
$ 0F )No error
° d ONLN dD 6R ü (N 6GetSourceDataEOF " ° ∂ R 4R0 ° ∂ ° ∂
° d ONLN d$g ~s +H"OSErr GetSourceDataEOF( ° d ONLN d<gsh )êCallBackProcPtr ° d ONLN dLgzs‡ )lpCallBackProcPtr, ° d ONLN dgr~, ({long* ° d ONLN dqrz~¬ )l theLength ); ° d ONLN d~Å ~ç — (ä ~pCallBackProcPtr ° d ONLN dèÅço )êThe callback pointer. ° d ONLN d•ï ~° ¥ (û ~ theLength ° d ONLN dÆï ¥° ∂ )6 ° d ONLN d∞ï°Î )Z2On output, contains the length of the source data.
° d ONLN d„≠ 6∂ s (¥ 6 DESCRIPTION
° d ONLN dÔº ~» í +HThe ° d ONLN dÛº í» Ú )GetSourceDataPos ° d ONLN dº Ú»¿ )`0 function returns the length of the source data. ° d ONLN d5“ ~fi (€ ~TSee interface file “AtomExtenderHeader.h” and glue code file “AtomExtenderCBGlue.c”.
° d ONLN däÍ 6Û { (Ò 6 RESULT CODES
° d ONLN dóÛ ~ˇ Í +H kNotImplementedErr ° d ONLN d™Û ıˇ )w30901 ° d ONLN d∞Û ˇº )+!Routine not currently implemented ° d ONLN d“ˇ ~ ú ( ~noErr ° d ONLN dÿˇ )ã0 ° d ONLN d⁄ˇ F )No error
° d ONLN dÛ. ~:) +H_This section describes the routines available to manage static memory. Some code resources can ° d ONLN dS: ~F$ * \pass back a handle to static memory so the code resource can communicate between invocations ° d ONLN d∞F ~RÀ * Lof the code resource. Generally, these routines are available all the time.
° d ONLN d˝j 6x ~ (t 6
INewHandle " ° ∂ x 4x0 ° ∂ ° ∂
° d ONLN dç ~ô +H"Handle INewHandle( ° d ONLN d ç ¸ôV )~CallBackProcPtr ° d ONLN d,çhôŒ )lpCallBackProcPtr, ° d ONLN dFò ¸§ (° ¸long ° d ONLN dOòh§» )lnewHandleSize ); ° d ONLN d`ß ~≥ — (∞ ~pCallBackProcPtr ° d ONLN dqß≥o )êThe callback pointer. ° d ONLN d᪠~« à (ƒ ~
newHandleSize ° d ONLN dîª Ã« Œ )N ° d ONLN dñª«Ã )B*The requested size to allocate the handle.
INewHandle ° d ONLN d Q Œ ]+ )<P function attempts to allocate a handle of the specified size. If the memory is ° d ONLN d _ ] ~ iˆ ( f ~Snot immediately available, the Installer writes out any buffered target data to the ° d ONLN d ≥ i ~ u * \appropriate target disk, then tries again. The resulting handle is NULL if the handle could ° d ONLN d u ~ Å … * not be allocated. ° d ONLN d" ã ~ ó ë *Use ° d ONLN d& ã ë ó Õ )
IDisposHandle ° d ONLN dB≈ ‡—¥ )N/ function disposes the handle in the parameter ° d ONLN dq≈¥— )‘
storageHandle ° d ONLN d~≈— )N. The ° d ONLN dÖ— ~›u (⁄ ~7handle could have been allocated using the Installer’s ° d ONLN dº—u›± )˜
INewHandle ° d ONLN dΔ—±›, )< function, or with any other ° d ONLN d„› ~È ¯ (Ê ~Macintosh Toolbox routine. ° d ONLN d˛Û ~ˇª *DSee interface file “InstallerMemoryFuncsHeader.h” and glue code file ° d ONLN dCˇ ~ * “InstallerMemoryCBGlue.c”.
° d ONLN d^ 6 { ( 6 RESULT CODES
° d ONLN dk ~, Í +H kNotImplementedErr ° d ONLN d~ ı, )w30901 ° d ONLN dÑ ,º )+!Routine not currently implemented ° d ONLN d¶, ~8 ú (5 ~noErr ° d ONLN d¨, 8 )ã0 ° d ONLN dÆ, 8F )No error ° d ONLN d∑8 ~D º (A ~ nilHandleErr ° d ONLN dƒ8 ˚D )}-109 ° d ONLN d…8 DÅ )%NULL master pointer ° d ONLN d›D ~P ≥ (M ~memWZErr ° d ONLN dÊD ˚P )}-111 ° d ONLN dÎD Pπ )%"Attempt to operate on a free block
° d ONLN dd 6r ^ (n 6IHLock " ° ∂ r 4r0 ° ∂ ° ∂
° d ONLN dá ~ì ñ +H"void ° d ONLN dá ¢ì, )$IHLock( CallBackProcPtr ° d ONLN d2á2ìò )êpCallBackProcPtr, ° d ONLN dJí ÿû (õ ÿHandle ° d ONLN dRíûn )6storageHandle ); ° d ONLN dc° ~≠ — (™ ~pCallBackProcPtr ° d ONLN dt°≠o )êThe callback pointer. ° d ONLN däµ ~¡ à (æ ~
storageHandle ° d ONLN dóµ á Œ )N ° d ONLN dôµ¡f )BThe handle to lock.
Q ∂ ]Y )$% function locks the specified handle. ° d ONLN d 0 g ~ sª ( p ~DSee interface file “InstallerMemoryFuncsHeader.h” and glue code file ° d ONLN d u s ~ * “InstallerMemoryCBGlue.c”.
° d ONLN d ê ã 6 î n ( í 6 IMPORTANT
° d ONLN d ö ò ~ § ¥ +H Always use ° d ONLN d • ò ¥ § ÿ )6IHLock ° d ONLN d ´ ò ÿ §l )$" to lock a handle allocated using ° d ONLN d Õ òl §® )î
INewHandle ° d ONLN d ◊ ò® §´ )<.
° d ONLN d Ÿ ∞ 6 π { ( ∑ 6 RESULT CODES
° d ONLN d Ê π ~ ≈ Í +H kNotImplementedErr ° d ONLN d ˘ π ı ≈ )w30901 ° d ONLN d ˇ π ≈º )+!Routine not currently implemented ° d ONLN d! ≈ ~ — ú ( Œ ~noErr ° d ONLN d' ≈ — )ã0 ° d ONLN d) ≈ —F )No error ° d ONLN d2 — ~ › Δ ( ⁄ ~ nilHandleErr ° d ONLN d? — ˚ › )}-109 ° d ONLN dD — ›Å )%NULL master pointer ° d ONLN dX › ~ È Æ ( Ê ~memWZErr ° d ONLN da › ˚ È )}-111 ° d ONLN df › Èπ )%"Attempt to operate on a free block
° d ONLN dâ ˝ 6 p ( 6IHUnLock " ° ∂ 4 0 ° ∂ ° ∂
° d ONLN dí ~, ñ +H"void ° d ONLN dó ¢, fi )$
IHUnLock( ° d ONLN d¢ Í,D )HCallBackProcPtr ° d ONLN d≤ V,º )lpCallBackProcPtr, ° d ONLN dÀ+ Í7 (4 ÍHandle ° d ONLN d÷+V7∂ )lstorageHandle ); ° d ONLN dÁ: ~F — (C ~pCallBackProcPtr ° d ONLN d¯:Fo )êThe callback pointer. ° d ONLN dN ~Z Ã (W ~
storageHandle ° d ONLN dN ÃZ Œ )N ° d ONLN d NZf )BThe handle to lock.
° d ONLN d1f 6o s (m 6 DESCRIPTION
° d ONLN d=u ~Å í +HThe ° d ONLN dAu íÅ ¬ )IHUnLock ° d ONLN dIu ¬Åo )0' function unlocks the specified handle. ° d ONLN dqã ~óª (î ~DSee interface file “InstallerMemoryFuncsHeader.h” and glue code file ° d ONLN d∂ó ~£ * “InstallerMemoryCBGlue.c”.
° d ONLN d—Ø 6∏ n (∂ 6 IMPORTANT
° d ONLN d€º ~» ¥ +H Always use ° d ONLN dʺ ¥» ‰ )6IHUnLock ° d ONLN dÓº ‰»Ç )0$ to unlock a handle allocated using ° d ONLN dºÇ»æ )û
INewHandle ° d ONLN d ºæ»¡ )<.
° d ONLN d ‘ 6› { (€ 6 RESULT CODES
° d ONLN d+› ~È Í +H kNotImplementedErr ° d ONLN d>› ıÈ )w30901 ° d ONLN dD› Ⱥ )+!Routine not currently implemented ° d ONLN dfÈ ~ı ú (Ú ~noErr ° d ONLN dlÈ ı )ã0 ° d ONLN dnÈ ıF )No error ° d ONLN dwı ~ Δ (˛ ~ nilHandleErr ° d ONLN dÑı ˚ )}-109 ° d ONLN dâı Å )%NULL master pointer ° d ONLN dù ~
Æ (
~memWZErr ° d ONLN d¶ ˚
)}-111 ° d ONLN d´
π )%"Attempt to operate on a free block
° d ONLN dŒ 6+ â (' 6Misc. Routines " ° ∂ + 4+0 ° ∂ ° ∂
° d ONLN d›0 ~<ù +H@This section describes various miscellaneous routines available.
actionClassID ° d ONLN d Q ]â )êThe action class ID number. ° d ONLN d * e ~ q « ( n ~actionIdentifier ° d ONLN d ; e qí )ê The action identifier number. ° d ONLN d Y y ~ Ö Õ ( Ç ~
• ±- * Ainformation back to the caller. The format of the data structure ° d ONLN dO ± Ω˘ * 4is defined individually for those actions that allow ° d ONLN dÑ Ω …Ö * modification to the result.
° d ONLN d† ’ 6 fi s ( ‹ 6 DESCRIPTION
° d ONLN d¨ ‰ ~ í +HThe ,
Courier ° d ONLN d∞ ‰ í
)RegisterScriptAction ° d ONLN dƒ ‰
)x? function registers an action with the Installer, which will be ° d ONLN d ~ ¸ ( ˘ ~Yimmediately given to all loaded Action Handlers. This function is made available to help ° d ONLN d^ ¸ ~& * acode resource writers easily send text messages to the Installer Debugger, using the action class ° d ONLN d¿ ~´ * ?kDebuggingAction, and the action identifier kGenericDebugActID. ° d ONLN d ~* *USee interface file “ActionHandlerHeader.h” and glue code file “ActionHanderCBGlue.c”.
° d ONLN dV6 6? n (= 6 IMPORTANT
° d ONLN d`C ~OÙ +HQRegisterScriptAction cannot be called from within an ActionHandler code resource.
° d ONLN d≤g 6u ® (q 6SuspendWaitCursor " ° ∂ u 4u0 ° ∂ ° ∂
° d ONLN dƒä ~ñh +H"'void SuspendWaitCursor( CallBackProcPtr ° d ONLN dÏäzñÊ )¸pCallBackProcPtr ) ° d ONLN dˇô ~• — (¢ ~pCallBackProcPtr ° d ONLN dô•o )êThe callback pointer.
° d ONLN d&± 6∫ s (∏ 6 DESCRIPTION
° d ONLN d2¿ ~à µ +H Calling the ° d ONLN d>¿ µÃ )7SuspendWaitCursor ° d ONLN dO¿Ã )f< function stops the wait cursor and returns the cursor to an ° d ONLN dåà ~ÿ* (’ ~^arrow. Use the ResumeWaitCursor to begin the wait cursor again. This is handy if you want to ° d ONLN dÎÿ ~‰Ü * ;show a dialog from a code resource during the installation. ° d ONLN d'Ó ~˙˝ *PSee interface file “ActionAtomHeader.h” and glue code file “ActionAtomCBGlue.c”.
° d ONLN dâ5 ~Ab +H"&void ResumeWaitCursor( CallBackProcPtr ° d ONLN d∞5hA‘ )ÍpCallBackProcPtr ) ° d ONLN d√D ~P — (M ~pCallBackProcPtr ° d ONLN d‘DPo )êThe callback pointer.
° d ONLN dÍ\ 6e s (c 6 DESCRIPTION
° d ONLN dˆk ~w µ +H Calling the ° d ONLN dk µw )7ResumeWaitCursor ° d ONLN dkw– )`- function sets the cursor to the wait cursor. ° d ONLN d@Å ~ç˝ (ä ~PSee interface file “ActionAtomHeader.h” and glue code file “ActionAtomCBGlue.c”.
° d ONLN d§» ~‘ +H"void IncrementStatusBar( ° d ONLN dæ» ‘z )¢CallBackProcPtr ° d ONLN dŒ»å‘Ú )lpCallBackProcPtr, ° d ONLN dÈ” fl> (‹ short ° d ONLN dÛ”åfl¯ )lpIncrementAmount ) ˇî d ˇ ˇˇˇˇ d
° d ONLN d Q ~ ] — ( Z ~pCallBackProcPtr ° d ONLN d Q ]o )êThe callback pointer. ° d ONLN d ' e ~ q ” ( n ~pIncrementAmount ° d ONLN d 8 e qr )êNumber of increments.
° d ONLN d N } 6 Ü s ( Ñ 6 DESCRIPTION
° d ONLN d Z å ~ ò µ +H Calling the ,
Courier ° d ONLN d f å µ ò! )7IncrementStatusBar ° d ONLN d x å! ò' )l< function increments the status bar during long waits inside ° d ONLN d µ ò ~ §" ( ° ~ayour code resource. Most often you’ll use this in your Action Atom code resource. Upon entry to ° d ONLN d § ~ ∞$ * ^your Action Atom you are given 100 status increments to use to show progress while executing a ° d ONLN dv ∞ ~ º' * _single Action Atom. The Installer limits the bar so you don’t have to worry about incrementing ° d ONLN d÷ º ~ » ¬ * the bar too far. ° d ONLN dË “ ~ fi˝ *PSee interface file “ActionAtomHeader.h” and glue code file “ActionAtomCBGlue.c”. ˇ “ d ˇ ˇˇˇˇ d
d , Palatino
. +~-C H A P T E R 7 , Helvetica
(Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ó113
$ ° d ONLN d Q ~ yÔ ( o ~Miscellaneous Features " ° ∂ 40 ° ∂ ° ∂
° d ONLN d ~* *∏ZThis chapter describes miscellaneous features of Installer 4.0 available to scriptwriters.
° d ONLN d rB 6V ı (Q 6About Action Handlers " ° ∂ V 4V0 ° ∂ ° ∂
° d ONLN d à[ ~g +H_Action Handlers allow external code resources to be called in response to specific actions in a ° d ONLN d Ëg ~s. * `“debug” version of the Installer. An action might provide information about which files will be ° d ONLN dIs ~ * [replaced during the installation, the reason the script cannot be read, the outcome of Easy ° d ONLN d• ~ãΔ * JInstall or Custom Install rule evaluation, or why the installation failed. ° d ONLN dÚì ~ü' *`The Action Handler code resource should be located in the script file. A “debug” version of the ° d ONLN dSü ~´ * ]Installer is available that has the necessary code to look for and send actions to all Action ° d ONLN d±´ ~∑õ * AHandlers found in the Installer application file and script file. ° d ONLN dÛø ~À *YApple supplies an Installer Debugger implemented as an Action Handler. Scriptwriters can ° d ONLN dMÀ ~◊0 * &write other Action Handlers as needed.
° d ONLN dtÎ ~˙ *"Writing an Action Handler " ° ∂ ˘ |˘0 ° ∂ ° ∂
° d ONLN dé˛ ~
( *dWhen the Installer first finds and opens the Installer script file it looks for all resources in the ° d ONLN dÛ
~+ * cscript and Installer file with the type ‘inah’. The ‘inah’ resource contains the type and ID is of ° d ONLN dW ~" * Xthe actual Action Handler code resource. Each of the code resources are loaded into the ° d ONLN d∞" ~.
* Installer’s heap and detached. ° d ONLN dœ6 ~B *]An Installer action consists of an action class ID and an action identifier. When a loggable ° d ONLN d-B ~N * _action occurs in the Installer, each Action Handler code resource is called with a pointer to a ° d ONLN dçN ~Z" * ]Action Handler parameter block. Action Handlers will be called in order of their resource ID ° d ONLN dÎZ ~f. * `(‘inah’ rsrc ID ). When called the Action Handler can handle the action however it desires, but ° d ONLN dLf ~r$ * [remember that other Action Handlers may be called before and after yours. Depending on the ° d ONLN d®r ~~" * ^action the Action Handler may be able to modify the result value to effect the progress of the ° d ONLN d~ ~ä5 * )Installer, such as when evaluating rules. ° d ONLN d1í ~û *]The Action Handler receives an initialize action when the script is first opened, and a close ° d ONLN dèû ~™ * [action when the Installer quits. Action Handlers can use the initialize action to allocate ° d ONLN dΙ ~∂- * \persistent memory to communicate between invocations of the same Action Handler. The Action ° d ONLN dH∂ ~¬£ * AHandler also receives all events that pass through the Installer. ˇ@ d ˇ ˇˇˇˇ d
d , Palatino
. +~*C H A P T E R 7 , Helvetica
*Misc. Features (Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ó114
° d ONLN d # d ~ p *YDuring execution the Action Handler shares memory space with the Installer. Local memory ° d ONLN d } p ~ |# * [allocation using Memory Manager calls will come from the Installer’s heap. Action Handlers ° d ONLN d Ÿ | ~ à Ú * should use the Installer’s ,
Courier ° d ONLN d Ù | Ú à. )t
INewHandle ° d ONLN d ˛ |. à )<5 routine to allocate memory that it wishes to persist ° d ONLN d4 à ~ î$ ( ë ~$between calls to the Action Handler.
° d ONLN dr ≈ ~ — +H_This section describes the data structures, resource descriptions and defined actions needed to ° d ONLN d“ — ~ › * use or write Action Handlers.
° d ONLN d Ò 6 ú ( ˝ 6Data Structures " ° ∂ 40 ° ∂ ° ∂
° d ONLN d ~ +H]This section describes the function prototype, parameter block structure and defined actions.
° d ONLN dq9 ~E˛ +HUThe Installer calls your Action Handler code resource assuming the following function ° d ONLN d«E ~Q ∂ * declaration. ° d ONLN d‘U ~a *long HandleAction( ° d ONLN dËU ¸ah )~ActionHandlerPBPtr ° d ONLN d¸Uåa
)êtheActionHandlerPB ); ° d ONLN do ~{) (x ~\The Action Handler writer should look at the actionClassID and actionIdentifier to determine ° d ONLN do{ ~á* * \how to react to the action. The four parameters, fParam0, fParam1, fParam2 and fParam3 will ° d ONLN dÃá ~ìˇ * Vcontain additional information depending on the action. You’ll need to include either ° d ONLN d#ì ~ü' * X“ActionHandlerHeader.h” or “ActionHandlerHeader.p” to allow access to the defined action ° d ONLN d|ü ~´
° d ONLN dÆ“ ~fi- +H`The Installer calls your Action Handler code resource, passing it the following parameter block. ° d ONLN d‚ ~Ó ÿ *typedef struct{ ° d ONLN d Ì ~˘ ê * <-> ° d ONLN d#Ì ¢˘ Δ )$Handle ° d ONLN d,Ì ¸˘V )ZfStaticDataHdl; ° d ONLN d<¯ ~ ê ( ~ —> ° d ONLN d@¯ ¢ à )$ProcPtr ° d ONLN dJ¯ ¸b )ZfCallBackProcPtr; ° d ONLN d\ ~ ê ( ~ —> ° d ONLN d` ¢ ¿ )$short ° d ONLN di ¸V )ZfTargetVRefNum; ° d ONLN dy ~ ê ( ~ —> ° d ONLN d} ¢ ∫ )$long ° d ONLN dÖ ¸n )ZfTargetFolderDirID; ° d ONLN dô ~% ê (" ~ —> ° d ONLN dù ¢% ¿ )$short ° d ONLN d¶ ¸%V )ZfSystemVRefNum; ° d ONLN d∂$ ~0 ê (- ~ —> ° d ONLN d∫$ ¢0 ∫ )$long ° d ONLN d¬$ ¸0t )ZfSystemBlessedDirID; ° d ONLN d◊/ ~; ê (8 ~ -> ° d ONLN d€/ ¢; ¿ )$short ° d ONLN d‰/ ¸;V )ZfActionClassID; ° d ONLN dÙ: ~F ê (C ~ -> ° d ONLN d¯: ¢F ¿ )$short ° d ONLN d: ¸Fh )ZfActionIdentifier; ° d ONLN dE ~Q ê (N ~ -> ° d ONLN dE ¢Q ¿ )$void* ° d ONLN d!E ¸Q, )ZfParam0; ° d ONLN d*P ~\ ê (Y ~ -> ° d ONLN d.P ¢\ ¿ )$void* ° d ONLN d7P ¸\, )ZfParam1; ° d ONLN d@[ ~g ê (d ~ -> ° d ONLN dD[ ¢g ¿ )$void* ° d ONLN dM[ ¸g, )ZfParam2; ° d ONLN dVf ~r ê (o ~ -> ° d ONLN dZf ¢r ¿ )$void* ° d ONLN dcf ¸r, )ZfParam3; ° d ONLN dmq ~} ê (z ~ -> ° d ONLN dqq ¢} ¿ )$void* ° d ONLN dzq ¸}> )Z fResultPtr; ° d ONLN dá| ~àh (Ö ~'} ActionHandlerPB, *ActionHandlerPBPtr;
° d ONLN dØò ~£ ◊ *Field descriptions
° d ONLN d√¶ ~≤ “ *fStaticDataHdl ° d ONLN d“¶≤( )ê:A handle created by the Action Handler using INewHandle to ° d ONLN d
≤æ * :save information between calls to this Action Handler code ° d ONLN dHæ + * <resource. The field is always NULL when your Action Handler ° d ONLN dÖ ÷! * @is initialized. You can assign a value to this field during any ˇ, d ˇ ˇˇˇˇ d
d , Palatino
. +~*C H A P T E R 7 , Helvetica
*Misc. Features (Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ó115
° d ONLN d Q ]& ( Z>call to the Action Handler, and receive the same value in this ° d ONLN d ? ] iå * field during the next action. ,
fResultPtr ° d ONLN d»Èı* )êBA pointer to the result variable. This is used by some actions to ° d ONLN d ı * <enable the Action Handler to change the result, such as with ° d ONLN dH
p * rules and rule clauses.
° d ONLN d`! 6/ a (+ 6Actions " ° ∂ / 4/0 ° ∂ ° ∂
° d ONLN dh4 ~@¸ +HYThe following is listing of the current actions supported by the Installer. See the file ° d ONLN d¬@ ~Lƒ * G“ActionHandlerHeader.h” file for a complete description of all actions. ° d ONLN d
P ~\ æ *Action Class: ° d ONLN dP æ\ )@kDebuggingAction ° d ONLN d*\ ~h ˆ (e ~kInitializationActID ° d ONLN d?g ~s ¿ * kCloseActID ° d ONLN dKr ~~ “ * kStdEventActID ° d ONLN dZ} ~â Í * kGenericDebugActID ° d ONLN dmì ~ü æ *Action Class: ° d ONLN d|ì æü )@
kScriptAction ° d ONLN däü ~´ ¸ (® ~kPackageNotFoundActID ° d ONLN d†™ ~∂ * kAtomNotFoundInPackageActID ° d ONLN dºµ ~¡ * kFrameworkNotFoundActID ° d ONLN d‘¿ ~Ã Í * kRuleNotFoundActID ° d ONLN dÁÀ ~◊ * kFileSpecNotFoundActID ° d ONLN d˛÷ ~‚ * kFileSpecIsBadActID ˇ V d ˇ ˇˇˇˇ d
kRsrcCopiedID ° d ONLN d … ¿ ~ Ã fi * kRsrcNotCopiedID ° d ONLN d ⁄ À ~ ◊ * kRsrcNotCopiedNewerLeftID ° d ONLN d Ù ÷ ~ ‚ * kRsrcNotCopiedNotTargetID ° d ONLN d · ~ Ì * kRsrcNotCopiedProtectedID ° d ONLN d( Ï ~ ¯ “ * kRsrcUpdatedID ° d ONLN d7 ˜ ~ * kRsrcNotUpdatedKeptExistID ° d ONLN dR ~ * kRsrcNotUpdatedLockedID ° d ONLN dj
~ * kRsrcNotUpdatedNotExistID ° d ONLN dÑ ~$ * kRsrcNotUpdatedProtectedID ° d ONLN dü# ~/ “ * kRsrcRemovedID ° d ONLN dÆ. ~: ‰ * kRsrcNotRemovedID ° d ONLN d¿9 ~E * kRsrcNotRemovedNoExistID ° d ONLN dŸD ~P * kRsrcNotRemovedProtectedID ° d ONLN dÙO ~[ * kRsrcNotRemovedLockedID ° d ONLN d e ~q æ *Action Class: ° d ONLN de æq0 )@kFontProgressAction ° d ONLN d/q ~} Ã (z ~
° d ONLN d†I 6Y Ω (U 6Resource Description " ° ∂ Y 4Y0 ° ∂ ° ∂
° d ONLN dµ^ ~jë +H;The template of the Action Handler resource is shown below. ° d ONLN dÒn ~z ® *#define ° d ONLN d˘n ¥z )6actionHandlerFlags ° d ONLN dn‘z⁄ (w‘\ ° d ONLN dy ¢Ö (Ç ¢
fill bit[16]; ° d ONLN d'è ~õ Ã (ò ~
type 'inah' { ° d ONLN d7ö ¢¶ “ +$ switch { ° d ONLN dC• ¥± +
case format0: ° d ONLN dU∞ Δº& + key integer = 0; ° d ONLN dh∞VºŒ )ê/* Format version */ ° d ONLN dŪ Δ«8 (ƒ ΔactionHandlerFlags; ° d ONLN dñªV«Ú )ê/* Action Handler Flags */ ° d ONLN dµΔ Δ“& (œ Δliteral longint; ° d ONLN d»ΔV“" )ê"/* Action Handler Code Rsrc Type*/ ° d ONLN dÔ— Δ›& (⁄ Δliteral integer; ° d ONLN d—V› )ê /* Action Handler Code Rsrc ID*/ ˇ
° d ONLN d Q Δ ] ˆ ( Z Δlongint; ° d ONLN d QV ] )ê /* Minimal Required Memory */ ° d ONLN d 0 \ Δ h, ( e ΔevenPaddedString; ° d ONLN d D \V hº )ê/* Description */ ° d ONLN d Y g ¢ s Æ ( p ¢}; ° d ONLN d \ r ~ ~ ä ( { ~};
° d ONLN d _ é ~ ô ◊ *Field descriptions
° d ONLN d s ú ~ ® ˆ *Action Handler Flags ° d ONLN d á ú ˆ ® ¯ )x ° d ONLN d â ú ® )=Currently reserved for use by Apple Computer, Inc. (2-bytes) ° d ONLN d « ∞ ~ º, ( π ~ Action Handler Code Rsrc Type ° d ONLN d  ª « +ê :The resource type of the Action Handler code resource. (4 ° d ONLN d ª « ( ƒ- ° d ONLN d « ”* ( –bytes) ° d ONLN d' € ~ Á ( ‰ ~Action Handler Code Rsrc ID ° d ONLN dC Ê Ú& +ê ?The resource ID of the Action Handler code resource. (2-bytes) ° d ONLN dÉ ˙ ~ ( ~Minimal Required Memory ° d ONLN dõ ˙ )ê8The minimum number of free bytes the Action Handler code ° d ONLN d‘» * +resource needs during execution. (4-bytes) ° d ONLN d ~& ÿ (# ~Handler Summary ° d ONLN d&+ )ê>An optional string briefly describing what this Action Handler ° d ONLN dP&2( * @does. This string is never displayed to the user. (even-padded ° d ONLN dë2>L * Pascal string)
° d ONLN d°V 6j¢ (e 6-About the Installer Version Resource (‘invs’) " ° ∂ j 4j0 ° ∂ ° ∂
° d ONLN dœo ~{ +HZYou may want to ensure that the version of the Installer that you used for development and ° d ONLN d*{ ~á * \testing and that you shipped is the one that is launched. To do so, add an 'invs' Installer ° d ONLN dáá ~ì * bVersion resource to specify the specific Installer version needed for your script. If you require ° d ONLN dÍì ~ü' * cInstaller 4.0 and a different version is launched and the version specified in this resource is 4.0 ° d ONLN dNü ~´! * \then the Installer will display a dialog saying something like “The Installer document [your ° d ONLN d´´ ~∑% * _document's name here] requires version [invs version number here] of the Installer application. ° d ONLN d ∑ ~√ * ]Try opening the Installer application that is in the same folder as this Installer document.” ° d ONLN djÀ ~◊+ *`The Installer uses the four hex bytes that specify the version number to compare against its own ° d ONLN dÀ◊ ~„ * ^version. The string is used only in the dialog that is displayed when the two versions do not ° d ONLN d*„ ~Ô û * match. ° d ONLN d1˜ ~í *@The following is an example 'invs' resource for Installer 4.0.3. ° d ONLN dr ~ ¸ *resource 'invs' (1) { ° d ONLN dâ ê Δ + format0 { ° d ONLN dï ¢) ∫ + 0x4, ° d ONLN dú( ¢4 ¿ * 0x03, ° d ONLN d§3 ¢? “ * release, ° d ONLN dØ> ¢J ∫ * 0x0, ° d ONLN d∂I ¢U à * "4.0.3" ° d ONLN døT ê` ñ (] ê} ° d ONLN d¡_ ~k ä (h ~};
” ~ fl “ *Major Revision ° d ONLN d ” “ fl ‘ )T ° d ONLN d ” fl∞ )<$The major version number. (2-bytes) ° d ONLN d? Á ~ Û “ ( ~Minor Revision ° d ONLN dM Á “ Û ‘ )T ° d ONLN dO Á Û± )<$The minor version number. (2-bytes) ° d ONLN dt ˚ ~ Ã ( ~
Release Stage ° d ONLN dÅ ˚ à Œ )N ° d ONLN dÉ ˚! )B?The release stage. Four release stage constants are defined in ° d ONLN d√) * ?the InstallerTypes.r file: development, alpha, beta, final and ° d ONLN d _ * release. (2-bytes) ° d ONLN d' ~3 “ (0 ~Release Number ° d ONLN d%' “3 ‘ )T ° d ONLN d''3ï )< The release number. (2-bytes) ° d ONLN dF; ~G (D ~Short Version Number String ° d ONLN da; G" )¢ ° d ONLN ddFR. (O@Text description of version number. (even-padded Pascal string)
° d ONLN dŒÉ ~è +HaUse of the new script resource, ‘insz’ with an ID of 1 is recommend for scripts over 10K in size. ° d ONLN d1è ~õ * \When the script resources are loaded into memory, they actually go into a sub-heap inside of ° d ONLN déõ ~ß( * [the Installer’s main heap. This improves Memory Manager performance on older machines. In ° d ONLN dÍß ~≥ * Yprevious versions of the Installer, the size of this sub-heap was always overestimated to ° d ONLN dD≥ ~ø, * baccount for possibly compressed resources in the script file. This older scheme has the potential ° d ONLN dßø ~À˝ * Ufor wasting precious Installer heap memory, requiring a larger application partition. ° d ONLN d˝” ~fl! *^ScriptCheck 4.0 calculates this value and automatically places this resource into your script. ° d ONLN d]fl ~Î) * eThe size calculated is calculated using the following script resource types: 'inaa', 'infa', 'inra', ° d ONLN d√Î ~˜ * m'inff', 'inrm', 'intf', infs', 'inpk', 'inrl', 'infr', 'inex', 'invc', 'insp', 'inat', 'inbb', 'indo', incd', ° d ONLN d1˜ ~ ñ * 'insz' , Times
° d ONLN d|U ~a +H Format 0 of the ‘invs’ resource: ° d ONLN dùe ~q à *
type 'insz' { ° d ONLN d≠p ¢| “ +$ switch { ° d ONLN dπ{ ¥á +
case format0: ° d ONLN dÀÜ Δí& + key integer = 0; ° d ONLN d›ÜDíº )~/* Format version */ ° d ONLN dˆë Δù, (ö Δunsigned longint; ° d ONLN d ëDù )~#/* Script Sub-Heap Size in bytes */ ° d ONLN d/ú ¢® Æ (• ¢}; ° d ONLN d2ß ~≥ ä (∞ ~}; ˇ 8 d ˇ ˇˇˇˇ d
d , Palatino
. +~*C H A P T E R 7 , Helvetica
*Misc. Features (Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ó120 ° d ONLN d Q ~ \ ◊ ( Y ~Field descriptions ,
Courier
° d ONLN d _ ~ k ˆ *Script Sub-Heap Size ° d ONLN d ( _ k& )ê?The size in bytes the script resources will require when loaded ° d ONLN d h k w * =into memory. This value is used to create an optimally sized ° d ONLN d ¶ w ɢ * 7sub-heap for the Installer script resources. (4-bytes)
° d ONLN d fi õ 6 ØΔ ( ™ 60About the Script Creation Date Resource (‘incd’) " ° ∂ Ø 4 Ø0 ° ∂ ° ∂
° d ONLN d ¥ ~ ¿- +HdThe script creation date resource holds a copy of the script file’s creation date field. This value ° d ONLN dt ¿ ~ ø * Yis used by the Installer to correctly find and verify the source files when copied to an ° d ONLN dŒ à ~ ÿ. * ^AppleShare server. Because the creation date of the source files may have been changed during ° d ONLN d- ÿ ~ ‰ * `the copy, the Installer uses the creation date in the ‘incd’ resource to calculate a delta value ° d ONLN dé ‰ ~ ! * `using the script’s creation date stored in the file by the File Manager. Without this resource, ° d ONLN dÔ ~ ¸% * athe user may get an error after beginning the installation saying that the source files could not ° d ONLN dQ ¸ ~ ¶ * be found. ° d ONLN d[ ~ ø *GScriptCheck automatically updates or adds this resource to your script.
° d ONLN d£4 6H: (C 6 Script Creation Date Reference
° d ONLN d¬Y 6i Ω *"Resource Description " ° ∂ H 4H0 ° ∂ ° ∂ " ° ∂ i 4i0 ° ∂ ° ∂
° d ONLN d◊n ~z ‘ +HThe ‘incd’ resource: ° d ONLN dÏ~ ~ä Ã *
type 'incd' { ° d ONLN d¸â ¢ï +$ unsigned longint; ° d ONLN dâ ï )~&/* Script Creation Date in seconds. */ ° d ONLN d7î ê† ú (ù ê}; ° d ONLN d:ü ~´ ä (® ~};
° d ONLN d=ª ~Δ ◊ *Field descriptions
° d ONLN dP… ~’ ˆ *Script Creation Date ° d ONLN de…’ )ê=The original creation date in seconds of the script file. (4 ° d ONLN d¢…’ (“- ° d ONLN d£’·* (fibytes) ˇÚ d ˇ ˇˇˇˇ d
d , Palatino
. +~-C H A P T E R 8 , Helvetica
(Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ó121
$ ° d ONLN d Q ~ y£ ( o ~Installation Topics " ° ∂ 40 ° ∂ ° ∂
° d ONLN d ~* *∏[This chapter discusses information that may help some scriptwriters keep out of trouble and ° d ONLN d p* ~6( * 'provide solutions to unique situations.
° d ONLN d òN 6b (] 6Installing Desk Accessories " ° ∂ b 4b0 ° ∂ ° ∂
° d ONLN d ¥s ~Ç; +H! Installing into Pre-7.X Systems " ° ∂ Å |Å0 ° ∂ ° ∂
° d ONLN d ‘Ü ~í *\Desk Accessories are installed into the System file as 'DRVR' resources. The installer will ° d ONLN d1í ~û* * atake care of all of the DA's owned resources. Following is an example of a resource atom used to ° d ONLN dìû ~™^ * 2install a desk accessory. Flags with the comment ,
Courier ° d ONLN d≈û^™ )‡/* your choice */ ° d ONLN d◊û ™# )lcan be either value. ° d ONLN dÏÆ ~∫D (∑ ~!resource 'inra' (raDAtoInstall) { ° d ONLN dπ ê≈ Δ + format0 { ° d ONLN dƒ ¢– + deleteWhenRemoving, ° d ONLN d/ƒ –Ü )~/* your choice */ ° d ONLN dCœ ¢€ (ÿ ¢deleteWhenInstalling, ° d ONLN dYœ2€⁄ )ê /* remove the outdated DA */ ° d ONLN dx⁄ ¢Ê ¿ („ ¢copy, ° d ONLN dÅ⁄ ¸Ê∞ )Z /* Copy rsrc to destination */ ° d ONLN d¢Â ¢Ò Í (Ó ¢ tgtRequired, ° d ONLN dØ ¸Ò )Z//* Target file need already exist to install */ ° d ONLN d· ¢¸ ¸ (˘ ¢updateExisting, ° d ONLN dÒ¸t )l/* your choice */ ° d ONLN d˚ ¢ ( ¢copyIfNewOrUpdate, ° d ONLN d˚ Ü )~/* your choice */ ° d ONLN d, ¢ ( ¢ignoreProtection, ° d ONLN d>t )l/* your choice */ ° d ONLN dR ¢ ( ¢
srcNeedExist, ° d ONLN d` ¸ Ï )Z(/* Rsrc needs to exist on source disk */ ° d ONLN dã ¢( Ã (% ¢byName, ° d ONLN dï ¸(∂ )Z /* Use name to find the rsrc */ ° d ONLN d∑' ¢3 ˆ (0 ¢nameMustMatch, ° d ONLN dΔ' ¸3J )Z
/* ignored */ ° d ONLN d÷2 ¢> ¸ (; ¢fsTargetSystem, ° d ONLN dÊ2>( )l//* Tgt file spec "System Folder:System File" */ ° d ONLN d= ¢I ‰ (F ¢ fsSourceDA, ° d ONLN d%= ¸IÏ )Z(/* Source file spec where to get rsrc */ ° d ONLN dPH ¢T à (Q ¢'DRVR', ° d ONLN dZH ¸Tn )Z/* Resource type */ ° d ONLN dpS ¢_ Æ (\ ¢0, ° d ONLN dwS ¸_‘ )Z$/* Resource source id (must be 0) */ ° d ONLN dû^ ¢j Æ (g ¢0, ° d ONLN d•^ ¸j‘ )Z$/* Resource target id (must be 0) */ ° d ONLN dÃi ¢u Æ (r ¢0, ° d ONLN d”i ¸u¯ )Z*/* atom size (filled in by ScriptCheck) */ ° d ONLN d t ¢Ä> (} ¢"Desk Accessory: DA name", ° d ONLN dtDÄ» )¢/* Atom description */ ° d ONLN d4 ¢ã ˆ (à ¢"\0x00DA Name" ° d ONLN dC ¸ãn )Z/* Resource name */ ° d ONLN dXä êñ ú (ì ê}; ° d ONLN d[ï ~° ä (û ~}; ° d ONLN d^Ø ~ªÉ *:When installing DA's into System 6.0.x and prior, use the ° d ONLN dòØɪ (∏É'deleteWhenInstalling' ° d ONLN dÆت' )Ñ flag in ° d ONLN d∑ª ~« € (ƒ ~conjunction with the ° d ONLN dê €«; )]'updateExisting' ° d ONLN d‹ª;«Õ )`" flag. In general, always use the ° d ONLN dˇ« ~” (– ~'deleteWhenInstalling' ° d ONLN d«”i )Ñ option when using the ° d ONLN d,«i”… )g'updateExisting' ° d ONLN d<«…”+ )` flag. Conversely, use ° d ONLN dT” ~fl ê (‹ ~the ° d ONLN dX” êfl, )'dontDeleteWhenInstalling' ° d ONLN dr”,fln )ú flag with the ° d ONLN dÅ”nfl¬ )B'keepExisting' ° d ONLN d蔬fl⁄ )T flag. ˇº d ˇ ˇˇˇˇ d
d , Palatino
. +~*C H A P T E R 8 , Helvetica
*Installation Topics
(Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ó122
° d ONLN d Q ~ ` ( \ ~Installing into System 7.X " ° ∂ _ | _0 ° ∂ ° ∂
° d ONLN d d ~ p *[Desk Accessories are installed into the Apple Menu Items Folder that is found in the System ° d ONLN d w p ~ |¬ * KFolder. Each Desk Accessory is contained in a single file. Use a typical ,
Courier ° d ONLN d ¬ p¬ |Ê ( y¬'infa' ° d ONLN d » pÊ |( )$ to install your ° d ONLN d Ÿ | ~ à ë ( Ö ~DA. ˇ ö d ˇ ˇˇˇˇ d
d , Palatino
. +~-C H A P T E R 9 , Helvetica
(Ú ~ Installer 4.0.3 Technical Guide (ÚÉ )ó123
$ ° d ONLN d Q ~ y ( o ~Glossary " ° ∂ 40 ° ∂ ° ∂
° d ONLN d 2 ~> ß *à buffering ° d ONLN d 2>& )ê@The act of storing up atom data to be written to the target disk ° d ONLN d T>J# * Alater in the installation. This reduces the Installer’s need for ° d ONLN d ñJV‘ * /the target disk, in case the disk is ejectable. ° d ONLN d «^ ~j ∞ (g ~ folder-user ° d ONLN d ”^j' )ê?A reserved target pathname used in target file specs to specify ° d ONLN djv¥ * %the user-selected application folder. ° d ONLN d9~ ~ä œ (á ~“live” installatio ,
Courier ° d ONLN dK~ œä ’ )Qn ° d ONLN dM~ä )?;An installation where a file in the currently active System ° d ONLN dâäñ! * >Folder will be deleted or modified. This type of installation ° d ONLN d»ñ¢ * ;always requires that all other applications are quit before ° d ONLN d¢Æ% * @beginning the installation. The original file is never touched, ° d ONLN dEÆ∫ * =and is saved to provide for cancellation of the installation. ° d ONLN dɬ ~Œ í (À ~part ° d ONLN dଌ )ê:The portion of atom data that is given to an Atom Extender ° d ONLN d√Œ⁄) * <during a kBeforePart and kAfterPart message. May or may not ° d ONLN d ⁄Êõ * be the same as the source piece. ° d ONLN d!Ó ~˙ ∑ (˜ ~ preflighting ° d ONLN d.Ó˙! )ê>The tasks performed after the user clicks the “Install” button ° d ONLN dm˙ * 8and before the status dialog appears. Some of the tasks ° d ONLN d¶, * Aperformed are: checking for locked files, checking for protected ° d ONLN dË % * ?resources, calculating required target disk space, and checking ° d ONLN d( *π * *if a target file equates to a source file. ° d ONLN dS2 ~> ∑ (; ~ special-xxxx ° d ONLN d`2>' )ê?A reserved target pathname used in target file specs to specify ° d ONLN d†>J * =a special folder, usually a folder in the System Folder. The ° d ONLN dfiJV$ * Aname of the folder is found in a ‘fld#’ resource using the folder ° d ONLN d VbŸ * /type ( where ‘xxxx’ is the type of the folder). ° d ONLN dPj ~v ∑ (s ~
source pieces ° d ONLN d^jv
)ê9The portions of atom data on the source disk that will be ° d ONLN dòvÇ) * @combined during the installation to create the target data. For ° d ONLN dŸÇé * @example, a large file is split into three files so they will fit ° d ONLN déö- * Aonto floppy disks. Each of the three files would be considered a ° d ONLN d\ö¶F *
source piece. ° d ONLN djÆ ~∫ ô (∑ ~strike ° d ONLN dqÆ∫Œ )ê,The combination of size and style of a font. ˇ
